GSM

Defines a root class which is used to identify and control Gsm signal configuration.

class nirfmxgsm.gsm.Gsm(session, signal_name='', cloning=False)[source]

Bases: _GsmBase

Defines a root class which is used to identify and control Gsm signal configuration.

abort_measurements(selector_string)

Stops acquisition and measurements associated with the signal instance that you specify in the Selector String parameter. This acquisition and measurements were previously initiated by the initiate() method. Calling this method is optional, unless you want to stop a measurement before it is complete. This method executes even if there is an incoming error.

Parameters:: selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
Returns:: Returns the status code of this method. The status code either indicates success or describes a warning condition.
Return type:: int

analyze_iq_1_waveform(selector_string, result_name, x0, dx, iq, reset)

Performs the enabled measurements on the I/Q complex waveform that you specify in the IQ parameter. Call this method after you configure the signal and measurement attributes. You can fetch measurement results using the Fetch methods or result attributes in the attribute node. Use this method only if the RECOMMENDED_ACQUISITION_TYPE attribute value is either IQ or IQ or Spectral.

Note

Query the Recommended Acquisition Type attribute from the RFmxInstr Attribute after calling the commit() method.

Parameters:

selector_string (string) –
This parameter specifies the signal name and result name. The result name can either be specified through this input or the Result Name parameter. If you do not specify the result name in this parameter, either the result name specified by the Result Name parameter or the default result instance is used.

Example:

””

”result::r1”

You can use the build_result_string() method to build the Selector String.
result_name (string) –
This parameter specifies the name to be associated with measurement results. Provide a unique name, such as “r1” to enable fetching of multiple measurement results and traces. This input accepts the result name with or without the “result::” prefix. The default value is “” (empty string), which refers to the default result instance.

Example:

””

”result::r1”

”r1”
x0 (float) – This parameter specifies the start time of the input y array. This value is expressed in seconds.
dx (float) – This parameter specifies the time interval between the samples in the input y array. This value is expressed in seconds. The reciprocal of dx indicates the I/Q rate of the input signal.
iq (numpy.complex64) – This parameter specifies an array of complex-valued time domain data. The real and imaginary parts of this complex data array correspond to the in-phase (I) and quadrature-phase (Q) data, respectively.
reset (bool) – This parameter resets measurement averaging. If you enable averaging, set this parameter to TRUE for the first record and FALSE for the subsequent records.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

auto_level(selector_string, measurement_interval)

Examines the input signal to calculate the peak power level and sets it as the value of the REFERENCE_LEVEL attribute. Use this method to help calculate an approximate setting for the reference level.

The RFmxGSM Auto Level method performs the following tasks: #. Resets the mixer level, mixer level offset, and IF output power offset.

Sets the starting reference level to the maximum reference level supported by the device based on the current RF attenuation, mechanical attenuation, and preamplifier enabled settings.
Iterates to adjust the reference level based on the input signal peak power.
Uses immediate triggering and restores the trigger settings back to user setting after completing execution.

You can also specify the starting reference level using the AUTO_LEVEL_INITIAL_REFERENCE_LEVEL attribute. Call this method after configuring all signal attributes.

When using NI 5663, 5665, or 5668R devices, NI recommends that you set an appropriate value for mechanical attenuation before calling the RFmx GSM Auto Level method. Setting an appropriate value for mechanical attenuation reduces the number of times the attenuator settings are changed by this method, thus reducing wear and tear, and maximizing the life time of the attenuator.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
measurement_interval (float) –
This parameter specifies the acquisition length. Use this value to compute the number of samples to acquire from the signal analyzer. This value is expressed in seconds. The default value is 4.6 ms.

Auto Level method does not use any trigger for acquisition. It ignores the user-configured trigger attributes. NI recommends that you set a sufficiently high measurement interval to ensure that the acquired waveform is at least as long as one period of the signal.

Returns:

reference_level (float):: This parameter returns the estimated peak power level of the input signal. This value is expressed in dBm for RF devices and V_pk-pkfor baseband devices.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (reference_level, error_code)

static build_offset_string(selector_string, offset_number)

Creates an offset string to be used as the selector string with configuration or fetch attributes and methods.

Parameters:

selector_string (string) – Specifies the result name for building the selector string.
offset_number (int) – This parameter specifies the offset number for building the selector string.

Returns:

Contains the selector string created by this method.

Return type:

string

static build_result_string(result_name)

Creates selector string for use with configuration or fetch.

Parameters:: result_name (string) – Specifies the result name for building the selector string. This input accepts the result name with or without the “result::” prefix. Example: “”, “result::r1”, “r1”.
Returns:: Contains the selector string created by this method.
Return type:: string

static build_slot_string(selector_string, slot_number)

Creates a slot string to be used as the selector string with configuration or fetch attributes and methods.

Parameters:

selector_string (string) – Specifies the result name for building the selector string.
slot_number (int) – This parameter specifies the slot number for building the selector string.

Returns:

Contains the selector string created by this method.

Return type:

string

check_measurement_status(selector_string)

Checks the status of the measurement. Use this method to check for any errors that may occur during measurement or to check whether the measurement is complete and results are available.

Parameters:

selector_string (string) –

This parameter specifies a Selector String comprising of result name. The default is “” (empty string).

Example:

”result::r1”

You can use the build_result_string() method to build the selector string.

Returns:

done (bool):: This parameter indicates whether the measurement is complete.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (done, error_code)

clear_all_named_results(selector_string)

Clears all results for the signal that you specify in the Selector String parameter.

Parameters:: selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
Returns:: Returns the status code of this method. The status code either indicates success or describes a warning condition.
Return type:: int

clear_named_result(selector_string)

Clears a result instance specified by the result name in the Selector String parameter.

Parameters:

selector_string (string) –

This parameter specifies a Selector String comprising of result name. The default is “” (empty string).

Example:

”result::r1”

You can use the build_result_string() method to build the selector string.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

clone_signal_configuration(new_signal_name)

Creates a new instance of a signal by copying all the properties from an existing signal instance.

Parameters:

new_signal_name (string) –

This parameter specifies the name of the new signal. This parameter accepts the signal name with or without the "signal::" prefix.

Example:

"signal::NewSigName"

"NewSigName"

Returns:

cloned_signal (Gsm):: Contains a new GSM signal instance.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (cloned_signal, error_code)

commit(selector_string)

Commits settings to the hardware. Calling this method is optional. RFmxGSM commits settings to the hardware when you call the initiate() method.

Parameters:: selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
Returns:: Returns the status code of this method. The status code either indicates success or describes a warning condition.
Return type:: int

configure_auto_tsc_detection_enabled(selector_string, auto_tsc_detection_enabled)

Configures whether to auto detect the training sequence code (TSC).

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
auto_tsc_detection_enabled (enums.AutoTscDetectionEnabled, int) –
This parameter specifies whether to auto detect the TSC. The default value is True.

Name (Value)

Description

False (0)

The measurement uses the value which you configure using the TSC attribute.

True (1)

The measurement detects the TSC in the burst.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_band(selector_string, band)

Configures the band of operation.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

band (enums.Band, int) –

This parameter specifies the band of operation. The default value is PGSM.

Name (Value)	Description
PGSM (0)	The operation band is Primary GSM in the 900 MHz band.
EGSM (1)	The operation band is Extended GSM in the 900 MHz band.
RGSM (2)	The operation band is Railway GSM in the 900 MHz band.
DCS1800 (3)	The operation band is GSM in the 1800 MHz band.
PCS1900 (4)	The operation band is GSM in the 1900 MHz band.
GSM450 (5)	The operation band is GSM in the 450 MHz band.
GSM480 (6)	The operation band is GSM in the 480 MHz band.
GSM850 (7)	The operation band is GSM in the 850 MHz band.
GSM750 (8)	The operation band is GSM in the 750 MHz band.
T-GSM810 (9)	The operation band is terrestrial GSM in the 810 MHz band.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_burst_synchronization_type(selector_string, burst_synchronization_type)

Configures the burst synchronization type.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

burst_synchronization_type (enums.BurstSynchronizationType, int) –

This parameter specifies the method used to synchronize the burst. The default value is TSC.

Name (Value)	Description
TSC (0)	Synchronizes the measurement to the timing of the demodulated training sequence in the burst. The measurement requires a burst with a valid training sequence code (TSC). The measurement determines the T0 point by demodulating the burst and identifying the TSC.
Amplitude (1)	Synchronizes the measurement based on the RF envelope of the received signal. The measurement sets the T0 point as the center of the RF Envelope.
None (2)	Sets the T0 point to 273.23 µsec after the trigger.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_digital_edge_trigger(selector_string, digital_edge_source, digital_edge, trigger_delay, enable_trigger)

Configures the device to wait for a digital edge trigger and then marks a reference point within the record.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

digital_edge_source (string) –

This parameter specifies the source terminal for the digital-edge trigger. The default of this attribute is hardware dependent.

Name (Value)	Description
PFI0 (PFI0)	The trigger is received on PFI 0.
PFI1 (PFI1)	The trigger is received on PFI 1.
PXI_Trig0 (PXI_Trig0)	The trigger is received on PXI trigger line 0.
PXI_Trig1 (PXI_Trig1)	The trigger is received on PXI trigger line 1.
PXI_Trig2 (PXI_Trig2)	The trigger is received on PXI trigger line 2.
PXI_Trig3 (PXI_Trig3)	The trigger is received on PXI trigger line 3.
PXI_Trig4 (PXI_Trig4)	The trigger is received on PXI trigger line 4.
PXI_Trig5 (PXI_Trig5)	The trigger is received on PXI trigger line 5.
PXI_Trig6 (PXI_Trig6)	The trigger is received on PXI trigger line 6.
PXI_Trig7 (PXI_Trig7)	The trigger is received on PXI trigger line 7.
PXI_STAR (PXI_STAR)	The trigger is received on the PXI star trigger line.

digital_edge (enums.DigitalEdgeTriggerEdge, int) –
This parameter specifies the active edge for the trigger. This parameter is used only when you set the TRIGGER_TYPE attribute to Digital Edge. The default value is Rising Edge.

Name (Value)

Description

Rising Edge (0)

The trigger asserts on the rising edge of the signal.

Falling Edge (1)

The trigger asserts on the falling edge of the signal.
trigger_delay (float) – This parameter specifies the trigger delay time, in seconds. The default value is 0.
enable_trigger (bool) – This parameter specifies whether to enable the trigger. The default value is TRUE.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_external_attenuation(selector_string, external_attenuation)

Specifies the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
external_attenuation (float) – This parameter specifies the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer. This value is expressed in dB. For more information about attenuation, refer to the External Attenuation and Signal Levels topic for your device in the NI RF Vector Signal Analyzers Help. The default value is 0.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_frequency(selector_string, center_frequency)

Configures the center frequency of the RF signal to acquire.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
center_frequency (float) – This parameter specifies the expected center frequency of the RF signal to acquire. This value is expressed in Hz. The signal analyzer tunes to this frequency. The default of this attribute is hardware dependent.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_frequency_arfcn(selector_string, link_direction, band, arfcn)

Configures the center frequency from the absolute RF channel number (ARFCN), band, and the link direction.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
link_direction (enums.LinkDirection, int) –
This parameter specifies the source of the signal to be measured. The default value is Uplink.

Name (Value)

Description

Downlink (0)

The source is a base transceiver station.

Uplink (1)

The source is a mobile station.

band (enums.Band, int) –

This parameter specifies the band of operation. The default value is PGSM.

Name (Value)	Description
PGSM (0)	The operation band is Primary GSM in the 900 MHz band.
EGSM (1)	The operation band is Extended GSM in the 900 MHz band.
RGSM (2)	The operation band is Railway GSM in the 900 MHz band.
DCS1800 (3)	The operation band is GSM in the 1800 MHz band.
PCS1900 (4)	The operation band is GSM in the 1900 MHz band.
GSM450 (5)	The operation band is GSM in the 450 MHz band.
GSM480 (6)	The operation band is GSM in the 480 MHz band.
GSM850 (7)	The operation band is GSM in the 850 MHz band.
GSM750 (8)	The operation band is GSM in the 750 MHz band.
T-GSM810 (9)	The operation band is terrestrial GSM in the 810 MHz band.

arfcn (int) – This parameter specifies the ARFCN. The default value is 1.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_iq_power_edge_trigger(selector_string, iq_power_edge_source, iq_power_edge_slope, iq_power_edge_level, trigger_delay, minimum_quiet_time_mode, minimum_quiet_time, iq_power_edge_level_type, enable_trigger)

Configures the device to wait for the complex power of the I/Q data to cross the specified threshold and then marks a reference point within the record. To trigger on bursty signals, specify a minimum quiet time, which ensures that the trigger does not occur in the middle of the burst signal. The quiet time must be set to a value smaller than the time between bursts, but large enough to ignore power changes within a burst.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
iq_power_edge_source (string) – This parameter specifies the channel from which the device monitors the trigger. The default of this attribute is hardware dependent.
iq_power_edge_slope (enums.IQPowerEdgeTriggerSlope, int) –
This parameter specifies whether the device asserts the trigger when the signal power is rising or when it is falling. The device asserts the trigger when the signal power exceeds the level that you specify in the IQ Power Edge Level parameter with the slope you specify. The default value is Rising Slope.

Name (Value)

Description

Rising Slope (0)

The trigger asserts when the signal power is rising.

Falling Slope (1)

The trigger asserts when the signal power is falling.
iq_power_edge_level (float) – This parameter specifies the power level at which the device triggers. This value is expressed in dB when you set the IQ Power Edge Level Type parameter to Relative; and is expressed in dBm when you set the IQ Power Edge Level Type parameter to Absolute. The device asserts the trigger when the signal exceeds the level specified by the value of this parameter, taking into consideration the specified slope. The default of this attribute is hardware dependent.
trigger_delay (float) – This parameter specifies the trigger delay time, in seconds. The default value is 0.

minimum_quiet_time_mode (enums.TriggerMinimumQuietTimeMode, int) –

This parameter specifies whether the measurement computes the minimum quiet time used for triggering. The default value is Auto.

Name (Value)	Description
Manual (0)	The minimum quiet time for triggering is the value of the Minimum Quiet Time parameter.
Auto (1)	The measurement computes the minimum quiet time used for triggering.

minimum_quiet_time (float) – This parameter specifies the time duration for which the signal must be quiet before the signal analyzer arms the I/Q power edge trigger. This value is expressed in seconds. If you set the IQ Power Edge Slope parameter to Rising Slope, the signal is quiet below the trigger level. If you set the IQ Power Edge Slope parameter to Falling Slope, the signal is quiet above the trigger level. The default value is 582 µs.

iq_power_edge_level_type (enums.IQPowerEdgeTriggerLevelType, int) –

This parameter specifies the reference for the IQ Power Edge Level parameter. The default value is Relative.

Name (Value)	Description
Relative (0)	The value of the IQ Power Edge Level parameter is relative to the value of the Reference Level attribute.
Absolute (1)	The IQ Power Edge Level parameter specifies the absolute power.

enable_trigger (bool) – This parameter specifies whether to enable the trigger. The default value is TRUE.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_link_direction(selector_string, link_direction)

Configures the source of the signal to be measured.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
link_direction (enums.LinkDirection, int) –
This parameter specifies the source of the signal to be measured. The default value is Uplink.

Name (Value)

Description

Downlink (0)

The source is a base transceiver station.

Uplink (1)

The source is a mobile station.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_number_of_timeslots(selector_string, number_of_timeslots)

Configures the number of time slots to be measured.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
number_of_timeslots (int) – This parameter specifies the number of time slots to be measured. The default value is 1.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_power_control_level(selector_string, power_control_level)

Configures the power control level corresponding to the transmitted power.

Use “slot<n>” as the selector string to configure this method.

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of slot number.

Example:

”slot0”

”slot::all”

You can use the build_slot_string() method to build the selector string.
power_control_level (int) – This parameter specifies the power control level corresponding to the transmitted power, as defined in section 4.1 of the 3GPP TS 45.005 v8.0.0 specifications. The default value is 0.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_reference_level(selector_string, reference_level)

Configures the reference level, which represents the maximum expected power of an RF input signal.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
reference_level (float) – This parameter specifies the reference level, which represents the maximum expected power of the RF input signal. This value is expressed in dBm for RF devices and V_pk-pkfor baseband devices. The default of this attribute is hardware dependent.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_rf(selector_string, center_frequency, reference_level, external_attenuation)

Configures the RF attributes of the signal specified by the selector string.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
center_frequency (float) – This parameter specifies the expected center frequency of the RF signal to acquire. This value is expressed in Hz. The signal analyzer tunes to this frequency. The default of this attribute is hardware dependent.
reference_level (float) – This parameter specifies the reference level, which represents the maximum expected power of the RF input signal. This value is expressed in dBm for RF devices and V_pk-pkfor baseband devices. The default of this attribute is hardware dependent.
external_attenuation (float) – This parameter specifies the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer. This value is expressed in dB. For more information about attenuation, refer to the External Attenuation and Signal Levels topic for your device in the NI RF Vector Signal Analyzers Help. The default value is 0.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_signal_type(selector_string, modulation_type, burst_type, hb_filter_width)

Configures the signal type.

Use “slot<n>” as the selector string to configure this method.

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of slot number.

Example:

”slot0”

”slot::all”

You can use the build_slot_string() method to build the selector string.

modulation_type (enums.ModulationType, int) –

This parameter specifies the modulation type of the signal. The default value is 8PSK.

Name (Value)	Description
GMSK (0)	The modulation type is Gaussian MSK. This value is valid only when you set the Burst Type parameter to NB or AB.
8PSK (1)	The modulation type is 8-PSK. This value is valid only when you set theBurst Type parameter to NB.
QPSK (2)	The modulation type is QPSK. This value is valid only when you set the Burst Type parameter to HB.
16QAM (3)	The modulation type is 16-QAM.
32QAM (4)	The modulation type is 32-QAM.

burst_type (enums.BurstType, int) –
This parameter specifies the burst type. The default value is NB.

Name (Value)

Description

NB (0)

The burst type is Normal Burst.

HB (1)

The burst type is Higher Symbol Rate Burst.

AB (2)

The burst type is Access Burst.
hb_filter_width (enums.HBFilterWidth, int) –
This parameter specifies the filter width when you set the Burst Type parameter to HB. The default value is Narrow.

Name (Value)

Description

Narrow (0)

The measurement uses a narrow filter.

Wide (1)

The measurement uses a wide filter.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_software_edge_trigger(selector_string, trigger_delay, enable_trigger)

Configures the device to wait for a software trigger and then marks a reference point within the record.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
trigger_delay (float) – This parameter specifies the trigger delay time, in seconds. The default value is 0.
enable_trigger (bool) – This parameter specifies whether to enable the trigger. The default value is TRUE.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

configure_tsc(selector_string, tsc)

Configures the training sequence code (TSC) in the burst.

Use “slot<n>” as the selector string to configure this method.

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of slot number.

Example:

”slot0”

”slot::all”

You can use the build_slot_string() method to build the selector string.

tsc (enums.Tsc, int) –

This parameter specifies the training sequence code in the burst. For access burst TSC0, TSC1, and TSC2 are applicable. The default value is TSC0.

Name (Value)	Description
TSC0 (0)	The measurement uses training sequence code 0.
TSC1 (1)	The measurement uses training sequence code 1.
TSC2 (2)	The measurement uses training sequence code 2.
TSC3 (3)	The measurement uses training sequence code 3.
TSC4 (4)	The measurement uses training sequence code 4.
TSC5 (5)	The measurement uses training sequence code 5.
TSC6 (6)	The measurement uses training sequence code 6.
TSC7 (7)	The measurement uses training sequence code 7.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

delete_signal_configuration()

Deletes the current instance of a signal.

Returns:: Returns the status code of this method. The status code either indicates success or describes a warning condition.
Return type:: error_code

disable_trigger(selector_string)

Configures the device to not wait for a trigger to mark a reference point within a record. This method defines the signal triggering as immediate.

Parameters:: selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
Returns:: Returns the status code of this method. The status code either indicates success or describes a warning condition.
Return type:: int

dispose(): Deletes the signal configuration if it is not the default signal configuration and clears any trace of the current signal configuration, if any.

Note

You can call this function safely more than once, even if the signal is already deleted.

get_auto_level_initial_reference_level(selector_string)

Gets the initial reference level the auto_level() method uses to estimate the peak power of the input signal. This value is expressed in dBm.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 30.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the initial reference level the auto_level() method uses to estimate the peak power of the input signal. This value is expressed in dBm.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_auto_tsc_detection_enabled(selector_string)

Gets whether the measurement automatically detects the training sequence code (TSC).

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is True.

Name (Value)	Description
False (0)	The measurement uses the value that you configure using the TSC attribute.
True (1)	The measurement detects the TSC in the burst.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AutoTscDetectionEnabled):: Specifies whether the measurement automatically detects the training sequence code (TSC).
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_band(selector_string)

Gets the operation band.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is PGSM.

Name (Value)	Description
PGSM (0)	The operation band is Primary GSM in the 900 MHz band.
EGSM (1)	The operation band is Extended GSM in the 900 MHz band.
RGSM (2)	The operation band is Railway GSM in the 900 MHz band.
DCS1800 (3)	The operation band is GSM in the 1800 MHz band.
PCS1900 (4)	The operation band is GSM in the 1900 MHz band.
GSM450 (5)	The operation band is GSM in the 450 MHz band.
GSM480 (6)	The operation band is GSM in the 480 MHz band.
GSM850 (7)	The operation band is GSM in the 850 MHz band.
GSM750 (8)	The operation band is GSM in the 750 MHz band.
TGSM810 (9)	The operation band is terrestrial GSM in the 810 MHz band.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.Band):: Specifies the operation band.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_burst_synchronization_type(selector_string)

Gets the method used to synchronize the burst.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is TSC.

Name (Value)	Description
TSC (0)	Synchronizes the measurement to the timing of the demodulated training sequence in the burst. The measurement requires a burst with a valid training sequence code (TSC). The measurement determines the T0 point by demodulating the burst and identifying the TSC.
Amplitude (1)	Synchronizes the measurement based on the RF envelope of the received signal. The measurement sets the T0 point as the center of the RF envelope.
None (2)	Sets the T0 point to 273.23 microseconds after the trigger.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.BurstSynchronizationType):: Specifies the method used to synchronize the burst.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_burst_type(selector_string)

Gets the burst type.

Use “slot<n>” as the selector string to configure or read this attribute.

The default value is NB.

Name (Value)	Description
NB (0)	The burst type is Normal Burst.
HB (1)	The burst type is Higher Symbol Rate Burst.
AB (2)	The burst type is Access Burst.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.BurstType):: Specifies the burst type.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_center_frequency(selector_string)

Gets the expected carrier frequency of the acquired RF signal. This value is expressed in Hz. The signal analyzer tunes to this frequency.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default of this attribute is hardware dependent.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the expected carrier frequency of the acquired RF signal. This value is expressed in Hz. The signal analyzer tunes to this frequency.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_digital_edge_trigger_edge(selector_string)

Gets the active edge for the trigger. This attribute is used only when you set the TRIGGER_TYPE attribute to Digital Edge.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Rising Edge.

Name (Value)	Description
Rising Edge (0)	The trigger asserts on the rising edge of the signal.
Falling Edge (1)	The trigger asserts on the falling edge of the signal.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DigitalEdgeTriggerEdge):: Specifies the active edge for the trigger. This attribute is used only when you set the TRIGGER_TYPE attribute to Digital Edge.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_digital_edge_trigger_source(selector_string)

Gets the source terminal for the digital edge trigger. This attribute is used only when you set the TRIGGER_TYPE attribute to Digital Edge.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default of this attribute is hardware dependent.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (string):: Specifies the source terminal for the digital edge trigger. This attribute is used only when you set the TRIGGER_TYPE attribute to Digital Edge.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_error_string(error_code)

Gets the description of a driver error code.

Parameters:: error_code (int) – Specifies an error or warning code.
Returns:: Contains the error description.
Return type:: string

get_external_attenuation(selector_string)

Gets the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer. This value is expressed in dB. For more information about attenuation, refer to the RF Attenuation and Signal Levels topic for your device in the NI RF Vector Signal Analyzers Help.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer. This value is expressed in dB. For more information about attenuation, refer to the RF Attenuation and Signal Levels topic for your device in the NI RF Vector Signal Analyzers Help.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_hb_filter_width(selector_string)

Gets the filter width when you set the BURST_TYPE attribute to HB.

Use “slot<n>” as the selector string to configure or read this attribute.

The default value is Narrow.

Name (Value)	Description
Narrow (0)	The measurement uses a narrow filter.
Wide (1)	The measurement uses a wide filter.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.HBFilterWidth):: Specifies the filter width when you set the BURST_TYPE attribute to HB.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_iq_power_edge_trigger_level(selector_string)

Gets the power level at which the device triggers. This value is expressed in dB when you set the IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE attribute to Relative and in dBm when you set the IQ Power Edge Level Type attribute to Absolute. The device asserts the trigger when the signal exceeds the level specified by the value of this attribute, taking into consideration the specified slope. This attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default of this attribute is hardware dependent.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the power level at which the device triggers. This value is expressed in dB when you set the IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE attribute to Relative and in dBm when you set the IQ Power Edge Level Type attribute to Absolute. The device asserts the trigger when the signal exceeds the level specified by the value of this attribute, taking into consideration the specified slope. This attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_iq_power_edge_trigger_level_type(selector_string)

Gets the reference for the IQ_POWER_EDGE_TRIGGER_LEVEL attribute. The IQ Power Edge Level Type attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Relative.

Name (Value)	Description
Relative (0)	The value of the IQ Power Edge Level attribute is relative to the value of the Reference Level attribute.
Absolute (1)	The IQ Power Edge Level attribute specifies the absolute power.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.IQPowerEdgeTriggerLevelType):: Specifies the reference for the IQ_POWER_EDGE_TRIGGER_LEVEL attribute. The IQ Power Edge Level Type attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_iq_power_edge_trigger_slope(selector_string)

Gets whether the device asserts the trigger when the signal power is rising or when it is falling. The device asserts the trigger when the signal power exceeds the level that you specify in the IQ_POWER_EDGE_TRIGGER_LEVEL attribute with the slope you specify. This attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Rising Slope.

Name (Value)	Description
Rising Slope (0)	The trigger asserts when the signal power is rising.
Falling Slope (1)	The trigger asserts when the signal power is falling.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.IQPowerEdgeTriggerSlope):: Specifies whether the device asserts the trigger when the signal power is rising or when it is falling. The device asserts the trigger when the signal power exceeds the level that you specify in the IQ_POWER_EDGE_TRIGGER_LEVEL attribute with the slope you specify. This attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_iq_power_edge_trigger_source(selector_string)

Gets the channel from which the device monitors the trigger. This attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default of this attribute is hardware dependent.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (string):: Specifies the channel from which the device monitors the trigger. This attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_limited_configuration_change(selector_string)

Gets the set of attributes that are considered by RFmx in the locked signal configuration state.

If your test system performs the same measurement at different selected ports, multiple frequencies and/or power levels repeatedly, enabling this attribute can help achieve faster measurements. When you set this attribute to a value other than Disabled, the RFmx driver will use an optimized code path and skip some checks. Because RFmx skips some checks when you use this attribute, you need to be aware of the limitations of this feature, which are listed in the Limitations of the Limited Configuration Change Property topic.

You can also use this attribute to lock a specific instrument configuration for a signal so that every time that you initiate the signal, RFmx applies the RFmxInstr attributes from a locked configuration.

NI recommends you use this attribute in conjunction with named signal configurations. Create named signal configurations for each measurement configuration in your test program and set this attribute to a value other than Disabled for one or more of the named signal configurations. This allows RFmx to precompute the acquisition settings for your measurement configurations and re-use the precomputed settings each time you initiate the measurement. You do not need to use this attribute if you create named signals for all the measurement configurations in your test program during test sequence initialization and do not change any RFInstr or personality attributes while testing each device under test. RFmx automatically optimizes that use case.

Specify the named signal configuration you are setting this attribute in the selector string input. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Disabled.

Name (Value)	Description
Disabled (0)	This is the normal mode of RFmx operation. All configuration changes in RFmxInstr attributes or in personality attributes will be applied during RFmx Commit.
No Change (1)	Signal configuration is locked after the first Commit of the named signal configuration. Any configuration change thereafter either in RFmxInstr attributes or personality attributes will not be considered by subsequent RFmx Commits or Initiates of this signal. Use No Change if you have created named signal configurations for all measurement configurations but are setting some RFmxInstr attributes. Refer to the Limitations of the Limited Configuration Change Property topic for more details about the limitations of using this mode.
Frequency (2)	Signal configuration, other than center frequency and external attenuation, is locked after first Commit of the named signal configuration. Thereafter, only the Center Frequency and External Attenuation attribute value changes will be considered by subsequent driver Commits or Initiates of this signal. Refer to the Limitations of the Limited Configuration Change Property topic for more details about the limitations of using this mode.
Reference Level (3)	Signal configuration, other than the reference level, is locked after first Commit of the named signal configuration. Thereafter only the Reference Level attribute value change will be considered by subsequent driver Commits or Initiates of this signal. If you have configured this signal to use an IQ Power Edge Trigger, NI recommends that you set the IQ Power Edge Level Type to Relative so that the trigger level is automatically adjusted as you adjust the reference level. Refer to the Limitations of the Limited Configuration Change Property topic for more details about the limitations of using this mode.
Freq and Ref Level (4)	Signal configuration, other than center frequency, reference level, and external attenuation, is locked after first Commit of the named signal configuration. Thereafter only Center Frequency, Reference Level, and External Attenuation attribute value changes will be considered by subsequent driver Commits or Initiates of this signal. If you have configured this signal to use an IQ Power Edge Trigger, NI recommends you set the IQ Power Edge Level Type to Relative so that the trigger level is automatically adjusted as you adjust the reference level. Refer to the Limitations of the Limited Configuration Change Property topic for more details about the limitations of using this mode.
Selected Ports, Freq and Ref Level (5)	Signal configuration, other than selected ports, center frequency, reference level, external attenuation, and RFInstr configuration, is locked after first Commit or Initiate of the named signal configuration. Thereafter only Selected Ports, Center Frequency, Reference Level, and External Attenuation attribute value changes will be considered by subsequent driver Commits or Initiates of this signal. If you have configured this signal to use an IQ Power Edge Trigger, NI recommends you set the IQ Power Edge Level Type to Relative so that the trigger level is automatically adjusted as you adjust the reference level. Refer to the Limitations of the Limited Configuration Change Property topic for more details about the limitations of using this mode.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.LimitedConfigurationChange):: Specifies the set of attributes that are considered by RFmx in the locked signal configuration state.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_link_direction(selector_string)

Gets the source of the signal to be measured.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Uplink.

Name (Value)	Description
Downlink (0)	The source is a base transceiver station.
Uplink (1)	The source is a mobile station.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.LinkDirection):: Specifies the source of the signal to be measured.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_modulation_type(selector_string)

Gets the modulation scheme used for the signal.

Use “slot<n>” as the selector string to configure or read this attribute.

The default value is 8PSK.

Name (Value)	Description
GMSK (0)	The modulation type is Gaussian minimum shift keying. This value is valid only when you set the Burst Type attribute to NB or AB.
8PSK (1)	The modulation type is 8-PSK. This value is valid only when you set the Burst Type attribute to NB.
QPSK (2)	The modulation type is QPSK. This value is valid only when you set the Burst Type attribute to HB.
16QAM (3)	The modulation type is 16-QAM.
32QAM (4)	The modulation type is 32-QAM.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModulationType):: Specifies the modulation scheme used for the signal.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_number_of_timeslots(selector_string)

Gets the number of time slots to be measured.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of time slots to be measured.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_power_control_level(selector_string)

Gets the power control level corresponding to the transmitted power, as defined in section 4.1 of the 3GPP TS 45.005 v8.0.0 specifications.

Use “slot<n>” as the selector string to configure or read this attribute.

The default value is 0. Valid values are 0 to 31, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the power control level corresponding to the transmitted power, as defined in section 4.1 of the 3GPP TS 45.005 v8.0.0 specifications.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_reference_level(selector_string)

Gets the reference level that represents the maximum expected power of the RF input signal. This value is expressed in dBm for RF devices and V_pk-pkfor baseband devices.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default of this attribute is hardware dependent.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the reference level that represents the maximum expected power of the RF input signal. This value is expressed in dBm for RF devices and V_pk-pkfor baseband devices.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_reference_level_headroom(selector_string)

Gets the margin RFmx adds to the REFERENCE_LEVEL attribute. The margin avoids clipping and overflow warnings if the input signal exceeds the configured reference level.

RFmx configures the input gain to avoid clipping and associated overflow warnings provided the instantaneous power of the input signal remains within the Reference Level plus the Reference Level Headroom. If you know the input power of the signal precisely or previously included the margin in the Reference Level, you could improve the signal-to-noise ratio by reducing the Reference Level Headroom.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

**Supported devices: **PXIe-5668R, PXIe-5830/5831/5832/5840/5841/5842/5860.

Default values

Name (value)	Description
PXIe-5668	6 dB
PXIe-5830/5831/5832/5841/5842/5860	1 dB
PXIe-5840	0 dB

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the margin RFmx adds to the REFERENCE_LEVEL attribute. The margin avoids clipping and overflow warnings if the input signal exceeds the configured reference level.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_result_fetch_timeout(selector_string)

Gets the time to wait before results are available in the RFmxGSM Attribute. This value is expressed in seconds.

Set this value to a time longer than expected for fetching the measurement. A value of -1 specifies that the RFmxGSM Attribute waits until the measurement is complete.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 10.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the time to wait before results are available in the RFmxGSM Attribute. This value is expressed in seconds.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_selected_ports(selector_string)

Gets the instrument port to be configured to acquire a signal. Use nirfmxinstr.session.Session.get_available_ports() method to get the valid port names.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

Valid values

Name (value)	Description
PXIe-5830	if0, if1
PXIe-5831/5832	if0, if1, rf<0-1>/port<x>, where 0-1 indicates one (0) or two (1) mmRH-5582 connections and x is the port number on the mmRH-5582 front panel
Other devices	“” (empty string)

Default values

Name (value)	Description
PXIe-5830/5831/5832	if1
Other devices	“” (empty string)

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (string):: Specifies the instrument port to be configured to acquire a signal. Use nirfmxinstr.session.Session.get_available_ports() method to get the valid port names.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_signal_structure(selector_string)

Gets whether the signal is bursted or continuous. For bursted signal and continuous signals, set the TRIGGER_TYPE to IQ Power Edge and None, respectively.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Bursted.

Name (Value)	Description
Bursted (0)	The signal is bursted.
Continuous (1)	The signal is continuous.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SignalStructure):: Specifies whether the signal is bursted or continuous. For bursted signal and continuous signals, set the TRIGGER_TYPE to IQ Power Edge and None, respectively.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_timing_advance(selector_string)

Gets the timing advance value as specified in the 3GPP TS 45.010 specification for GSM access burst.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the timing advance value as specified in the 3GPP TS 45.010 specification for GSM access burst.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_trigger_delay(selector_string)

Gets the trigger delay time. This value is expressed in seconds.

If the delay is negative, the measurement acquires pretrigger samples. If the delay is positive, the measurement acquires post-trigger samples.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the trigger delay time. This value is expressed in seconds.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_trigger_minimum_quiet_time_duration(selector_string)

Gets the time duration for which the signal must be quiet before the signal analyzer arms the I/Q power edge trigger. This value is expressed in seconds.

If you set the IQ_POWER_EDGE_TRIGGER_SLOPE attribute to Rising Slope, the signal is quiet below the trigger level. If you set the IQ Power Edge Slope attribute to Falling Slope, the signal is quiet above the trigger level.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default of this attribute is hardware dependent.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the time duration for which the signal must be quiet before the signal analyzer arms the I/Q power edge trigger. This value is expressed in seconds.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_trigger_minimum_quiet_time_mode(selector_string)

Gets whether the measurement computes the minimum quiet time used for triggering.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Auto.

Name (Value)	Description
Manual (0)	The minimum quiet time for triggering is the value of the Trigger Min Quiet Time attribute.
Auto (1)	The measurement computes the minimum quiet time used for triggering.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.TriggerMinimumQuietTimeMode):: Specifies whether the measurement computes the minimum quiet time used for triggering.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_trigger_type(selector_string)

Gets the trigger type.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is IQ Power Edge.

Name (Value)	Description
None (0)	No Reference Trigger is configured.
Digital Edge (1)	The Reference Trigger is not asserted until a digital edge is detected. The source of the digital edge is specified using the Digital Edge Source attribute.
IQ Power Edge (2)	The Reference Trigger is asserted when the signal changes past the level specified by the slope (rising or falling), which is configured using the IQ Power Edge Slope attribute.
Software (3)	The Reference Trigger is not asserted until a software trigger occurs.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.TriggerType):: Specifies the trigger type.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_tsc(selector_string)

Gets the training sequence code (TSC) to use. This attribute is applicable only when you set the BURST_SYNCHRONIZATION_TYPE attribute to TSC and the AUTO_TSC_DETECTION_ENABLED attribute to False. For access burst TSC0, TSC1, and TSC2 are applicable.

Use “slot<n>” as the selector string to configure or read this attribute.

The default value is TSC0.

Name (Value)	Description
TSC0 (0)	The measurement uses training sequence code 0.
TSC1 (1)	The measurement uses training sequence code 1.
TSC2 (2)	The measurement uses training sequence code 2.
TSC3 (3)	The measurement uses training sequence code 3.
TSC4 (4)	The measurement uses training sequence code 4.
TSC5 (5)	The measurement uses training sequence code 5.
TSC6 (6)	The measurement uses training sequence code 6.
TSC7 (7)	The measurement uses training sequence code 7.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.Tsc):: Specifies the training sequence code (TSC) to use. This attribute is applicable only when you set the BURST_SYNCHRONIZATION_TYPE attribute to TSC and the AUTO_TSC_DETECTION_ENABLED attribute to False. For access burst TSC0, TSC1, and TSC2 are applicable.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_warning()

Retrieves and then clears the warning information for the session.

Returns:

warning_code (int):: Contains the latest warning code.
warning_message (string):: Contains the latest warning description.

Return type:

Tuple (warning_code, warning_message)

initiate(selector_string, result_name)

Initiates all enabled measurements. Call this method after configuring the signal and measurement. This method asynchronously launches measurements in the background and immediately returns to the caller program. You can fetch measurement results using the Fetch methods or result attributes in the attribute node. To get the status of measurements, use the wait_for_measurement_complete() method or check_measurement_status() method.

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of result name. The result name can either be specified through this input or the Result Name parameter. If you do not specify the result name in this parameter, either the result name specified by the Result Name parameter or the default result instance is used. The default value is “” (empty string).

Example:

””

”result::r1”

You can use the build_result_string() method to build the selector string.
result_name (string) –
This parameter specifies the name to be associated with measurement results. Provide a unique name, such as “r1” to enable fetching of multiple measurement results and traces. This input accepts the result name with or without the “result::” prefix. The default value is “” (empty string), which refers to the default result instance.

Example:

””

”result::r1”

”r1”

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

reset_attribute(selector_string, attribute_id)

Resets the attribute to its default value.

Parameters:

selector_string (string) – Specifies the selector string for the property being reset.
attribute_id (PropertyId) – Specifies an attribute identifier.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

reset_to_default(selector_string)

Resets a signal to the default values.

Parameters:: selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
Returns:: Returns the status code of this method. The status code either indicates success or describes a warning condition.
Return type:: int

select_measurements(selector_string, measurements, enable_all_traces)

Enables all the measurements that you specify in the Measurements parameter and disables all other measurements.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

measurements (enums.MeasurementTypes, int) –

This parameter specifies the measurement to perform. You can specify one or more of the following measurements. The default is an empty array.

Name (Value)	Description
ModAcc (0)	Enables the modulation accuracy (ModAcc) measurement.
ORFS (1)	Enables the output radio frequency spectrum (ORFS) measurement.
PVT (2)	Enables the power versus time (PVT) measurement.

enable_all_traces (bool) – This parameter specifies whether to enable all traces for the selected measurement. The default value is FALSE.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

send_software_edge_trigger()

Sends a trigger to the device when you use the RFmxGSM Configure Trigger function to choose a software version of a trigger and the device is waiting for the trigger to be sent. You can also use this function to override a hardware trigger.

This function returns an error in the following situations:

You configure an invalid trigger.
You have not previously called the initiate function.

Returns:: Returns the status code of this method. The status code either indicates success or describes a warning condition.
Return type:: int

set_auto_level_initial_reference_level(selector_string, value)

Sets the initial reference level the auto_level() method uses to estimate the peak power of the input signal. This value is expressed in dBm.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 30.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the initial reference level the auto_level() method uses to estimate the peak power of the input signal. This value is expressed in dBm.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_auto_tsc_detection_enabled(selector_string, value)

Sets whether the measurement automatically detects the training sequence code (TSC).

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is True.

Name (Value)	Description
False (0)	The measurement uses the value that you configure using the TSC attribute.
True (1)	The measurement detects the TSC in the burst.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AutoTscDetectionEnabled, int) – Specifies whether the measurement automatically detects the training sequence code (TSC).

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_band(selector_string, value)

Sets the operation band.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is PGSM.

Name (Value)	Description
PGSM (0)	The operation band is Primary GSM in the 900 MHz band.
EGSM (1)	The operation band is Extended GSM in the 900 MHz band.
RGSM (2)	The operation band is Railway GSM in the 900 MHz band.
DCS1800 (3)	The operation band is GSM in the 1800 MHz band.
PCS1900 (4)	The operation band is GSM in the 1900 MHz band.
GSM450 (5)	The operation band is GSM in the 450 MHz band.
GSM480 (6)	The operation band is GSM in the 480 MHz band.
GSM850 (7)	The operation band is GSM in the 850 MHz band.
GSM750 (8)	The operation band is GSM in the 750 MHz band.
TGSM810 (9)	The operation band is terrestrial GSM in the 810 MHz band.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.Band, int) – Specifies the operation band.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_burst_synchronization_type(selector_string, value)

Sets the method used to synchronize the burst.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is TSC.

Name (Value)	Description
TSC (0)	Synchronizes the measurement to the timing of the demodulated training sequence in the burst. The measurement requires a burst with a valid training sequence code (TSC). The measurement determines the T0 point by demodulating the burst and identifying the TSC.
Amplitude (1)	Synchronizes the measurement based on the RF envelope of the received signal. The measurement sets the T0 point as the center of the RF envelope.
None (2)	Sets the T0 point to 273.23 microseconds after the trigger.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.BurstSynchronizationType, int) – Specifies the method used to synchronize the burst.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_burst_type(selector_string, value)

Sets the burst type.

Use “slot<n>” as the selector string to configure or read this attribute.

The default value is NB.

Name (Value)	Description
NB (0)	The burst type is Normal Burst.
HB (1)	The burst type is Higher Symbol Rate Burst.
AB (2)	The burst type is Access Burst.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.BurstType, int) – Specifies the burst type.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_center_frequency(selector_string, value)

Sets the expected carrier frequency of the acquired RF signal. This value is expressed in Hz. The signal analyzer tunes to this frequency.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default of this attribute is hardware dependent.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the expected carrier frequency of the acquired RF signal. This value is expressed in Hz. The signal analyzer tunes to this frequency.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_digital_edge_trigger_edge(selector_string, value)

Sets the active edge for the trigger. This attribute is used only when you set the TRIGGER_TYPE attribute to Digital Edge.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Rising Edge.

Name (Value)	Description
Rising Edge (0)	The trigger asserts on the rising edge of the signal.
Falling Edge (1)	The trigger asserts on the falling edge of the signal.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DigitalEdgeTriggerEdge, int) – Specifies the active edge for the trigger. This attribute is used only when you set the TRIGGER_TYPE attribute to Digital Edge.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_digital_edge_trigger_source(selector_string, value)

Sets the source terminal for the digital edge trigger. This attribute is used only when you set the TRIGGER_TYPE attribute to Digital Edge.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default of this attribute is hardware dependent.

Parameters:

selector_string (string) – Pass an empty string.
value (string) – Specifies the source terminal for the digital edge trigger. This attribute is used only when you set the TRIGGER_TYPE attribute to Digital Edge.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_external_attenuation(selector_string, value)

Sets the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer. This value is expressed in dB. For more information about attenuation, refer to the RF Attenuation and Signal Levels topic for your device in the NI RF Vector Signal Analyzers Help.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the attenuation of a switch or cable connected to the RF IN connector of the signal analyzer. This value is expressed in dB. For more information about attenuation, refer to the RF Attenuation and Signal Levels topic for your device in the NI RF Vector Signal Analyzers Help.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_hb_filter_width(selector_string, value)

Sets the filter width when you set the BURST_TYPE attribute to HB.

Use “slot<n>” as the selector string to configure or read this attribute.

The default value is Narrow.

Name (Value)	Description
Narrow (0)	The measurement uses a narrow filter.
Wide (1)	The measurement uses a wide filter.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.HBFilterWidth, int) – Specifies the filter width when you set the BURST_TYPE attribute to HB.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_iq_power_edge_trigger_level(selector_string, value)

Sets the power level at which the device triggers. This value is expressed in dB when you set the IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE attribute to Relative and in dBm when you set the IQ Power Edge Level Type attribute to Absolute. The device asserts the trigger when the signal exceeds the level specified by the value of this attribute, taking into consideration the specified slope. This attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default of this attribute is hardware dependent.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the power level at which the device triggers. This value is expressed in dB when you set the IQ_POWER_EDGE_TRIGGER_LEVEL_TYPE attribute to Relative and in dBm when you set the IQ Power Edge Level Type attribute to Absolute. The device asserts the trigger when the signal exceeds the level specified by the value of this attribute, taking into consideration the specified slope. This attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_iq_power_edge_trigger_level_type(selector_string, value)

Sets the reference for the IQ_POWER_EDGE_TRIGGER_LEVEL attribute. The IQ Power Edge Level Type attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Relative.

Name (Value)	Description
Relative (0)	The value of the IQ Power Edge Level attribute is relative to the value of the Reference Level attribute.
Absolute (1)	The IQ Power Edge Level attribute specifies the absolute power.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.IQPowerEdgeTriggerLevelType, int) – Specifies the reference for the IQ_POWER_EDGE_TRIGGER_LEVEL attribute. The IQ Power Edge Level Type attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_iq_power_edge_trigger_slope(selector_string, value)

Sets whether the device asserts the trigger when the signal power is rising or when it is falling. The device asserts the trigger when the signal power exceeds the level that you specify in the IQ_POWER_EDGE_TRIGGER_LEVEL attribute with the slope you specify. This attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Rising Slope.

Name (Value)	Description
Rising Slope (0)	The trigger asserts when the signal power is rising.
Falling Slope (1)	The trigger asserts when the signal power is falling.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.IQPowerEdgeTriggerSlope, int) – Specifies whether the device asserts the trigger when the signal power is rising or when it is falling. The device asserts the trigger when the signal power exceeds the level that you specify in the IQ_POWER_EDGE_TRIGGER_LEVEL attribute with the slope you specify. This attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_iq_power_edge_trigger_source(selector_string, value)

Sets the channel from which the device monitors the trigger. This attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default of this attribute is hardware dependent.

Parameters:

selector_string (string) – Pass an empty string.
value (string) – Specifies the channel from which the device monitors the trigger. This attribute is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_limited_configuration_change(selector_string, value)

Sets the set of attributes that are considered by RFmx in the locked signal configuration state.

If your test system performs the same measurement at different selected ports, multiple frequencies and/or power levels repeatedly, enabling this attribute can help achieve faster measurements. When you set this attribute to a value other than Disabled, the RFmx driver will use an optimized code path and skip some checks. Because RFmx skips some checks when you use this attribute, you need to be aware of the limitations of this feature, which are listed in the Limitations of the Limited Configuration Change Property topic.

You can also use this attribute to lock a specific instrument configuration for a signal so that every time that you initiate the signal, RFmx applies the RFmxInstr attributes from a locked configuration.

NI recommends you use this attribute in conjunction with named signal configurations. Create named signal configurations for each measurement configuration in your test program and set this attribute to a value other than Disabled for one or more of the named signal configurations. This allows RFmx to precompute the acquisition settings for your measurement configurations and re-use the precomputed settings each time you initiate the measurement. You do not need to use this attribute if you create named signals for all the measurement configurations in your test program during test sequence initialization and do not change any RFInstr or personality attributes while testing each device under test. RFmx automatically optimizes that use case.

Specify the named signal configuration you are setting this attribute in the selector string input. You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Disabled.

Name (Value)	Description
Disabled (0)	This is the normal mode of RFmx operation. All configuration changes in RFmxInstr attributes or in personality attributes will be applied during RFmx Commit.
No Change (1)	Signal configuration is locked after the first Commit of the named signal configuration. Any configuration change thereafter either in RFmxInstr attributes or personality attributes will not be considered by subsequent RFmx Commits or Initiates of this signal. Use No Change if you have created named signal configurations for all measurement configurations but are setting some RFmxInstr attributes. Refer to the Limitations of the Limited Configuration Change Property topic for more details about the limitations of using this mode.
Frequency (2)	Signal configuration, other than center frequency and external attenuation, is locked after first Commit of the named signal configuration. Thereafter, only the Center Frequency and External Attenuation attribute value changes will be considered by subsequent driver Commits or Initiates of this signal. Refer to the Limitations of the Limited Configuration Change Property topic for more details about the limitations of using this mode.
Reference Level (3)	Signal configuration, other than the reference level, is locked after first Commit of the named signal configuration. Thereafter only the Reference Level attribute value change will be considered by subsequent driver Commits or Initiates of this signal. If you have configured this signal to use an IQ Power Edge Trigger, NI recommends that you set the IQ Power Edge Level Type to Relative so that the trigger level is automatically adjusted as you adjust the reference level. Refer to the Limitations of the Limited Configuration Change Property topic for more details about the limitations of using this mode.
Freq and Ref Level (4)	Signal configuration, other than center frequency, reference level, and external attenuation, is locked after first Commit of the named signal configuration. Thereafter only Center Frequency, Reference Level, and External Attenuation attribute value changes will be considered by subsequent driver Commits or Initiates of this signal. If you have configured this signal to use an IQ Power Edge Trigger, NI recommends you set the IQ Power Edge Level Type to Relative so that the trigger level is automatically adjusted as you adjust the reference level. Refer to the Limitations of the Limited Configuration Change Property topic for more details about the limitations of using this mode.
Selected Ports, Freq and Ref Level (5)	Signal configuration, other than selected ports, center frequency, reference level, external attenuation, and RFInstr configuration, is locked after first Commit or Initiate of the named signal configuration. Thereafter only Selected Ports, Center Frequency, Reference Level, and External Attenuation attribute value changes will be considered by subsequent driver Commits or Initiates of this signal. If you have configured this signal to use an IQ Power Edge Trigger, NI recommends you set the IQ Power Edge Level Type to Relative so that the trigger level is automatically adjusted as you adjust the reference level. Refer to the Limitations of the Limited Configuration Change Property topic for more details about the limitations of using this mode.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.LimitedConfigurationChange, int) – Specifies the set of attributes that are considered by RFmx in the locked signal configuration state.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_link_direction(selector_string, value)

Sets the source of the signal to be measured.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Uplink.

Name (Value)	Description
Downlink (0)	The source is a base transceiver station.
Uplink (1)	The source is a mobile station.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.LinkDirection, int) – Specifies the source of the signal to be measured.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_modulation_type(selector_string, value)

Sets the modulation scheme used for the signal.

Use “slot<n>” as the selector string to configure or read this attribute.

The default value is 8PSK.

Name (Value)	Description
GMSK (0)	The modulation type is Gaussian minimum shift keying. This value is valid only when you set the Burst Type attribute to NB or AB.
8PSK (1)	The modulation type is 8-PSK. This value is valid only when you set the Burst Type attribute to NB.
QPSK (2)	The modulation type is QPSK. This value is valid only when you set the Burst Type attribute to HB.
16QAM (3)	The modulation type is 16-QAM.
32QAM (4)	The modulation type is 32-QAM.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.ModulationType, int) – Specifies the modulation scheme used for the signal.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_number_of_timeslots(selector_string, value)

Sets the number of time slots to be measured.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of time slots to be measured.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_power_control_level(selector_string, value)

Sets the power control level corresponding to the transmitted power, as defined in section 4.1 of the 3GPP TS 45.005 v8.0.0 specifications.

Use “slot<n>” as the selector string to configure or read this attribute.

The default value is 0. Valid values are 0 to 31, inclusive.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the power control level corresponding to the transmitted power, as defined in section 4.1 of the 3GPP TS 45.005 v8.0.0 specifications.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_reference_level(selector_string, value)

Sets the reference level that represents the maximum expected power of the RF input signal. This value is expressed in dBm for RF devices and V_pk-pkfor baseband devices.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default of this attribute is hardware dependent.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the reference level that represents the maximum expected power of the RF input signal. This value is expressed in dBm for RF devices and V_pk-pkfor baseband devices.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_reference_level_headroom(selector_string, value)

Sets the margin RFmx adds to the REFERENCE_LEVEL attribute. The margin avoids clipping and overflow warnings if the input signal exceeds the configured reference level.

RFmx configures the input gain to avoid clipping and associated overflow warnings provided the instantaneous power of the input signal remains within the Reference Level plus the Reference Level Headroom. If you know the input power of the signal precisely or previously included the margin in the Reference Level, you could improve the signal-to-noise ratio by reducing the Reference Level Headroom.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

**Supported devices: **PXIe-5668R, PXIe-5830/5831/5832/5840/5841/5842/5860.

Default values

Name (value)	Description
PXIe-5668	6 dB
PXIe-5830/5831/5832/5841/5842/5860	1 dB
PXIe-5840	0 dB

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the margin RFmx adds to the REFERENCE_LEVEL attribute. The margin avoids clipping and overflow warnings if the input signal exceeds the configured reference level.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_result_fetch_timeout(selector_string, value)

Sets the time to wait before results are available in the RFmxGSM Attribute. This value is expressed in seconds.

Set this value to a time longer than expected for fetching the measurement. A value of -1 specifies that the RFmxGSM Attribute waits until the measurement is complete.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 10.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the time to wait before results are available in the RFmxGSM Attribute. This value is expressed in seconds.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_selected_ports(selector_string, value)

Sets the instrument port to be configured to acquire a signal. Use nirfmxinstr.session.Session.get_available_ports() method to get the valid port names.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

Valid values

Name (value)	Description
PXIe-5830	if0, if1
PXIe-5831/5832	if0, if1, rf<0-1>/port<x>, where 0-1 indicates one (0) or two (1) mmRH-5582 connections and x is the port number on the mmRH-5582 front panel
Other devices	“” (empty string)

Default values

Name (value)	Description
PXIe-5830/5831/5832	if1
Other devices	“” (empty string)

Parameters:

selector_string (string) – Pass an empty string.
value (string) – Specifies the instrument port to be configured to acquire a signal. Use nirfmxinstr.session.Session.get_available_ports() method to get the valid port names.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_signal_structure(selector_string, value)

Sets whether the signal is bursted or continuous. For bursted signal and continuous signals, set the TRIGGER_TYPE to IQ Power Edge and None, respectively.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Bursted.

Name (Value)	Description
Bursted (0)	The signal is bursted.
Continuous (1)	The signal is continuous.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.SignalStructure, int) – Specifies whether the signal is bursted or continuous. For bursted signal and continuous signals, set the TRIGGER_TYPE to IQ Power Edge and None, respectively.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_timing_advance(selector_string, value)

Sets the timing advance value as specified in the 3GPP TS 45.010 specification for GSM access burst.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the timing advance value as specified in the 3GPP TS 45.010 specification for GSM access burst.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_trigger_delay(selector_string, value)

Sets the trigger delay time. This value is expressed in seconds.

If the delay is negative, the measurement acquires pretrigger samples. If the delay is positive, the measurement acquires post-trigger samples.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the trigger delay time. This value is expressed in seconds.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_trigger_minimum_quiet_time_duration(selector_string, value)

Sets the time duration for which the signal must be quiet before the signal analyzer arms the I/Q power edge trigger. This value is expressed in seconds.

If you set the IQ_POWER_EDGE_TRIGGER_SLOPE attribute to Rising Slope, the signal is quiet below the trigger level. If you set the IQ Power Edge Slope attribute to Falling Slope, the signal is quiet above the trigger level.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default of this attribute is hardware dependent.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the time duration for which the signal must be quiet before the signal analyzer arms the I/Q power edge trigger. This value is expressed in seconds.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_trigger_minimum_quiet_time_mode(selector_string, value)

Sets whether the measurement computes the minimum quiet time used for triggering.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is Auto.

Name (Value)	Description
Manual (0)	The minimum quiet time for triggering is the value of the Trigger Min Quiet Time attribute.
Auto (1)	The measurement computes the minimum quiet time used for triggering.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.TriggerMinimumQuietTimeMode, int) – Specifies whether the measurement computes the minimum quiet time used for triggering.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_trigger_type(selector_string, value)

Sets the trigger type.

You do not need to use a Selector String to configure or read this attribute for the default signal instance. Refer to the Selector String topic for information about the string syntax for named signals.

The default value is IQ Power Edge.

Name (Value)	Description
None (0)	No Reference Trigger is configured.
Digital Edge (1)	The Reference Trigger is not asserted until a digital edge is detected. The source of the digital edge is specified using the Digital Edge Source attribute.
IQ Power Edge (2)	The Reference Trigger is asserted when the signal changes past the level specified by the slope (rising or falling), which is configured using the IQ Power Edge Slope attribute.
Software (3)	The Reference Trigger is not asserted until a software trigger occurs.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.TriggerType, int) – Specifies the trigger type.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

set_tsc(selector_string, value)

Sets the training sequence code (TSC) to use. This attribute is applicable only when you set the BURST_SYNCHRONIZATION_TYPE attribute to TSC and the AUTO_TSC_DETECTION_ENABLED attribute to False. For access burst TSC0, TSC1, and TSC2 are applicable.

Use “slot<n>” as the selector string to configure or read this attribute.

The default value is TSC0.

Name (Value)	Description
TSC0 (0)	The measurement uses training sequence code 0.
TSC1 (1)	The measurement uses training sequence code 1.
TSC2 (2)	The measurement uses training sequence code 2.
TSC3 (3)	The measurement uses training sequence code 3.
TSC4 (4)	The measurement uses training sequence code 4.
TSC5 (5)	The measurement uses training sequence code 5.
TSC6 (6)	The measurement uses training sequence code 6.
TSC7 (7)	The measurement uses training sequence code 7.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.Tsc, int) – Specifies the training sequence code (TSC) to use. This attribute is applicable only when you set the BURST_SYNCHRONIZATION_TYPE attribute to TSC and the AUTO_TSC_DETECTION_ENABLED attribute to False. For access burst TSC0, TSC1, and TSC2 are applicable.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int

signal_configuration_name = '': Name assigned to the current signal configuration object.

signal_configuration_type = None: Type of the current signal configuration object.

wait_for_measurement_complete(selector_string, timeout)

Waits for the specified number for seconds for all the measurements to complete.

Parameters:

selector_string (string) –
This parameter specifies a Selector String comprising of result name. The default is “” (empty string).

Example:

”result::r1”

You can use the build_result_string() method to build the selector string.
timeout (float) – This parameter specifies the time for which the method waits for the measurement to complete. This value is expressed in seconds. A value of -1 specifies that the method waits until the measurement is complete.

Returns:

Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

int