Demod

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

class nirfmxdemod.demod.Demod(session, signal_name='', cloning=False)[source]

Bases: _DemodBase

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

abort_measurements(selector_string)

Stops acquisition as well as the measurements that are associated with the signal instance and that were previously initiated by the initiate() method or measurement read methods.

Parameters:

selector_string (string) –

This parameter comprises of the signal name.

Example:

””

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

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. When using the Analysis-Only mode in RFmxDemod, the RFmx driver ignores the RFmx hardware settings such as reference level and attenuation. The only RF hardware settings that are not ignored are the center frequency and trigger type, since it is needed for spectral measurement traces as well as some measurements such as ModAcc, ACP, and SEM.

Note

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

Parameters:

selector_string (string) –
This parameter specifies the 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, bandwidth, 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 RFmxDemod Auto Level method does the following tasks: #. Resets the mixer level, mixer level offset, and IF output power level offset.

Sets the starting reference level to the maximum reference level supported by the device based on the current RF attenuation, mechanical attenuation, and preamp 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 the execution.

You can also specify the starting reference level using the AUTO_LEVEL_INITIAL_REFERENCE_LEVEL attribute.

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

Parameters:

selector_string (string) –
This parameter comprises of the signal name.

Example:

””

You can use the build_result_string() method to build the Selector String.
bandwidth (float) – This parameter specifies the bandwidth, in Hz, of the signal to be analyzed.
measurement_interval (float) –
This parameter specifies the acquisition length. This value is used to compute the number of samples to acquire from the signal analyzer. This value is expressed in seconds. The default value is 10 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_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

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 comprises the signal name and result name.

Example:

””

”result::r1”

You can use the build_result_string() method to build the Selector String.

Returns:

is_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 (is_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) –

This parameter comprises of the signal name.

Example:

””

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

clear_named_result(selector_string)

Clears an instance of the result that you specify in the Selector String parameter.

Parameters:

selector_string (string) –

This parameter comprises the signal name and result name.

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 (demod):: Contains a new Demod 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. RFmxDemod commits settings to the hardware when you call the initiate() method or any of the measurement Read methods.

Parameters:

selector_string (string) –

This parameter comprises of the signal name.

Example:

””

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

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

Configures the digital edge trigger.

Parameters:

selector_string (string) –
This parameter comprises of the signal name.

Example:

””

You can use the build_result_string() method to build the Selector String.

digital_edge_source (string) –

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

The default value is PFI0.

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.
PXIe_DStarB (PXIe_DStarB)	The trigger is received on the PXIe DStar B trigger line.
TimerEvent (TimerEvent)	The trigger is received from the Timer Event.

digital_edge (enums.DigitalEdgeTriggerEdge, int) –
This parameter specifies whether the signal analyzer detects a rising or falling edge on the digital-edge trigger signal. The 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.
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)

Configures the attenuation of a switch (or cable) connected to the RF IN connector of the signal analyzer.

Parameters:

selector_string (string) –
This parameter comprises of the signal name.

Example:

””

You can use the build_result_string() method to build the Selector String.
external_attenuation (float) – This parameter specifies the attenuation, in dB, of a switch (or cable) connected to the RF IN connector of the signal analyzer. For more information about attenuation, refer to the 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

configure_frequency(selector_string, center_frequency)

Configures the expected carrier frequency of the RF signal that needs to be acquired. The signal analyzer tunes to this frequency.

Parameters:

selector_string (string) –
This parameter comprises of the signal name.

Example:

””

You can use the build_result_string() method to build the Selector String.
center_frequency (float) –
This parameter specifies the carrier frequency, in Hz, of the RF signal that needs to be acquired. 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_iq_power_edge_trigger(selector_string, iq_power_edge_trigger_source, iq_power_edge_trigger_level, iq_power_edge_slope, trigger_delay, minimum_quiet_time_mode, minimum_quiet_time_duration, enable_trigger)

Configures the I/Q power edge trigger.

Parameters:

selector_string (string) –
This parameter comprises of the signal name.

Example:

””

You can use the build_result_string() method to build the Selector String.
iq_power_edge_trigger_source (string) –
This parameter specifies the channel from which the device monitors the trigger.

The default value is 0.
iq_power_edge_trigger_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 this value 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.
iq_power_edge_slope (enums.IQPowerEdgeTriggerSlope, int) –
This parameter specifies whether the device asserts the trigger when the signal power is rising or falling. The device asserts the trigger when the signal power exceeds the specified level with the slope you specify. This parameter is used only when you set the TRIGGER_TYPE attribute to IQ Power Edge.

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.
trigger_delay (float) – This parameter specifies the trigger delay time, in seconds.

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 Manual.

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

minimum_quiet_time_duration (float) – This parameter specifies the time duration, in seconds, for which the signal must be quiet before the signal analyzer arms the I/Q power-edge trigger.
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_reference_level(selector_string, reference_level)

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

Parameters:

selector_string (string) –
This parameter comprises of the signal name.

Example:

””

You can use the build_result_string() method to build the Selector String.
reference_level (float) – This parameter specifies the reference level which represents the maximum expected power of an RF input signal. This value is expressed in dBm for RF devices and V_pk-pkfor baseband devices. The default of this parameter 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 by specifying the selector string.

Parameters:

selector_string (string) –
This parameter comprises of the signal name.

Example:

””

You can use the build_result_string() method to build the Selector String.
center_frequency (float) –
This parameter specifies the carrier frequency, in Hz, of the RF signal that needs to be acquired. 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, in dB, of a switch (or cable) connected to the RF IN connector of the signal analyzer. For more information about attenuation, refer to the 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

configure_software_edge_trigger(selector_string, trigger_delay, enable_trigger)

Configures the software-edge trigger.

Parameters:

selector_string (string) –
This parameter comprises of the signal name.

Example:

””

You can use the build_result_string() method to build the Selector String.
trigger_delay (float) – This parameter specifies the trigger delay time, in seconds.
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

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)

Disables the trigger.

Parameters:

selector_string (string) –

This parameter comprises of the signal name.

Example:

””

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

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_all_named_result_names(selector_string)

Returns all the named result names of 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:

result_names (string):: Returns an array of result names.
default_result_exists (bool):: Indicates whether the default result exists.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (result_names, default_result_exists, error_code)

get_auto_level_initial_reference_level(selector_string)

Gets the initial reference level which 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 which 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_center_frequency(selector_string)

Gets the carrier frequency of the RF signal that needs to be acquired. 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 carrier frequency of the RF signal that needs to be acquired. 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 whether the signal analyzer detects a rising or falling edge on the digital-edge trigger signal. This attribute is applicable 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 whether the signal analyzer detects a rising or falling edge on the digital-edge trigger signal. This attribute is applicable 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 applicable 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 applicable 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. For more information about attenuation, refer to the Attenuation and Signal Levels topic for your device in the NI RF Vector Signal Analyzers Help. This value is expressed in dB.

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. For more information about attenuation, refer to the Attenuation and Signal Levels topic for your device in the NI RF Vector Signal Analyzers Help. This value is expressed in dB.
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. 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 Absolute.

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. 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_slope(selector_string)

Gets whether the device asserts the trigger when the signal power is rising or falling. The device asserts the trigger when the signal power exceeds the specified level 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 falling. The device asserts the trigger when the signal power exceeds the specified level 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 applicable 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 applicable 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 attribute 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 attribute 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_reference_level(selector_string)

Gets 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.

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 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.
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-5668, 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 RFmxDemod Attribute. Set this value to a time longer than expected for fetching the measurement. A value of -1 specifies that the RFmxDemod Attribute waits until the measurement is complete. This value is expressed in seconds.

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 RFmxDemod Attribute. Set this value to a time longer than expected for fetching the measurement. A value of -1 specifies that the RFmxDemod Attribute waits until the measurement is complete. 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_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 seconds.

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. If you set the TRIGGER_TYPE 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. This value is expressed in seconds.

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. If you set the TRIGGER_TYPE 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. 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 Manual.

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 type of Reference Trigger to use for signal acquisition.

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 None.

Name (Value)	Description
None (0)	No reference trigger is used for signal acquisition.
Digital Edge (1)	A digital-edge trigger is used for signal acquisition. The source of the digital edge is specified using the Digital Edge Source attribute.
IQ Power Edge (2)	An I/Q power-edge trigger is used for signal acquisition, which is configured using the IQ Power Edge Slope attribute.
Software (3)	A software trigger is used for signal acquisition.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.TriggerType):: Specifies the type of Reference Trigger to use for signal acquisition.
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, you can use the wait_for_measurement_complete() method or the 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 input, either the result name specified by Result Name parameter or the default result instance is used. The default 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 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) –

This parameter comprises of the signal name.

Example:

””

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

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) –
This parameter comprises of the signal name.

Example:

””

You can use the build_result_string() method to build the Selector String.
measurements (enums.MeasurementTypes, int) –
This parameter specifies an array of measurements to perform. You can specify the following measurements.

Name (Value)

Description

ADemod (0)

Enables analog demodulation measurements.

DDemod (1)

Enables digital demodulation measurements.
enable_all_traces (bool) – This parameter specifies whether to enable all the traces for the selected measurements.

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 RFmxDemod 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 which 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 which 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_center_frequency(selector_string, value)

Sets the carrier frequency of the RF signal that needs to be acquired. 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 carrier frequency of the RF signal that needs to be acquired. 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 whether the signal analyzer detects a rising or falling edge on the digital-edge trigger signal. This attribute is applicable 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 whether the signal analyzer detects a rising or falling edge on the digital-edge trigger signal. This attribute is applicable 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 applicable 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 applicable 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. For more information about attenuation, refer to the Attenuation and Signal Levels topic for your device in the NI RF Vector Signal Analyzers Help. This value is expressed in dB.

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. For more information about attenuation, refer to the Attenuation and Signal Levels topic for your device in the NI RF Vector Signal Analyzers Help. This value is expressed in dB.

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. 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 Absolute.

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. 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_slope(selector_string, value)

Sets whether the device asserts the trigger when the signal power is rising or falling. The device asserts the trigger when the signal power exceeds the specified level 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 falling. The device asserts the trigger when the signal power exceeds the specified level 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 applicable 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 applicable 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 attribute 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 attribute 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_reference_level(selector_string, value)

Sets 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.

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 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.

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-5668, 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 RFmxDemod Attribute. Set this value to a time longer than expected for fetching the measurement. A value of -1 specifies that the RFmxDemod Attribute waits until the measurement is complete. This value is expressed in seconds.

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 RFmxDemod Attribute. Set this value to a time longer than expected for fetching the measurement. A value of -1 specifies that the RFmxDemod Attribute waits until the measurement is complete. 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_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 seconds.

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. If you set the TRIGGER_TYPE 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. This value is expressed in seconds.

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. If you set the TRIGGER_TYPE 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. 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 Manual.

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 type of Reference Trigger to use for signal acquisition.

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 None.

Name (Value)	Description
None (0)	No reference trigger is used for signal acquisition.
Digital Edge (1)	A digital-edge trigger is used for signal acquisition. The source of the digital edge is specified using the Digital Edge Source attribute.
IQ Power Edge (2)	An I/Q power-edge trigger is used for signal acquisition, which is configured using the IQ Power Edge Slope attribute.
Software (3)	A software trigger is used for signal acquisition.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.TriggerType, int) – Specifies the type of Reference Trigger to use for signal acquisition.

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 comprises the signal name and result name.

Example:

””

”result::r1”

You can use the build_result_string() method to build the Selector String.
timeout (float) – This parameter specifies the timeout for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10. 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