IMConfiguration

Provides methods to configure the IM measurement.

class nirfmxspecan.im_configuration.IMConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the IM measurement.

configure_auto_intermods_setup(selector_string, auto_intermods_setup_enabled, maximum_intermod_order)[source]

Configures whether the measurement computes the intermod frequencies or uses manually specified frequencies.

Parameters:

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

  • auto_intermods_setup_enabled (enums.IMAutoIntermodsSetupEnabled, int) –

    This parameter specifies whether the measurement computes the intermod frequencies or uses manually specified frequencies. The default value is True.

    Name (Value)

    Description

    False (0)

    The measurement uses the values that you specify for the IM Lower Intermod Freq and IM Upper Intermod Freq attributes.

    True (1)

    The measurement computes intermod frequencies. The number of intermods to measure is based on the value of the Maximum Intermod Order parameter.

  • maximum_intermod_order (int) –

    This parameter specifies the order up to which the RFmx driver measures odd order intermodulation products when you set the Auto Intermods Setup Enabled parameter to True. The lower and upper intermodulation products are measured for each order. The default value is 3.

    Name (Value)

    Description

    3 (3)

    The RFmx driver measures third order intermodulation products.

    5 (5)

    The RFmx driver measures third and fifth order intermodulation products.

    7 (7)

    The RFmx driver measures third, fifth, and seventh order intermodulation products.

    9 (9)

    The RFmx driver measures third, fifth, seventh, and ninth order intermodulation products.

Returns:

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

Return type:

int

configure_averaging(selector_string, averaging_enabled, averaging_count, averaging_type)[source]

Configures averaging for the IM measurement.

Parameters:

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

  • averaging_enabled (enums.IMAveragingEnabled, int) –

    This parameter specifies whether to enable averaging for the measurement. The default value is False.

    Name (Value)

    Description

    False (0)

    The measurement is performed on a single acquisition.

    True (1)

    The measurement uses the value of the Averaging Count parameter to calculate the number of acquisitions over which the measurement is averaged.

  • averaging_count (int) – This parameter specifies the number of acquisitions used for averaging when you set the Averaging Enabled parameter to True. The default value is 10.

  • averaging_type (enums.IMAveragingType, int) –

    This parameter specifies the averaging type for averaging the power over multiple acquisitions. The averaged power trace is used for the measurement. Refer to the Averaging section of the Spectrum topic for more information about averaging types. The default value is RMS.

    Name (Value)

    Description

    RMS (0)

    The power trace is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.

    Log (1)

    The power trace is averaged in a logarithmic scale.

    Scalar (2)

    The square root of the power trace is averaged.

    Max (3)

    The peak power in the power trace at each sample instance is retained from one acquisition to the next.

    Min (4)

    The least power in the power trace at each sample instance is retained from one acquisition to the next.

Returns:

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

Return type:

int

configure_fft(selector_string, fft_window, fft_padding)[source]

Configures the window and FFT to obtain a spectrum for the IM measurement.

Parameters:

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

  • fft_window (enums.IMFftWindow, int) –

    This parameter specifies the FFT window type to use to reduce spectral leakage. Refer to the Window and FFT section of the Spectral Measurements Concepts topic for more information about FFT window types. The default value is Flat Top.

    Name (Value)

    Description

    None (0)

    Analyzes transients for which duration is shorter than the window length. You can also use this window type to separate two tones with frequencies close to each other but with almost equal amplitudes.

    Flat Top (1)

    Measures single-tone amplitudes accurately.

    Hanning (2)

    Analyzes transients for which duration is longer than the window length. You can also use this window type to provide better frequency resolution for noise measurements.

    Hamming (3)

    Analyzes closely-spaced sine waves.

    Gaussian (4)

    Provides a balance of spectral leakage, frequency resolution, and amplitude attenuation. This windowing is useful for time-frequency analysis.

    Blackman (5)

    Analyzes single tone because it has a low maximum side lobe level and a high side lobe roll-off rate.

    Blackman-Harris (6)

    Useful as a general purpose window, having side lobe rejection greater than 90 dB and having a moderately wide main lobe.

    Kaiser-Bessel (7)

    Separates two tones with frequencies close to each other but with widely-differing amplitudes.

  • fft_padding (float) – This parameter specifies the factor by which the time-domain waveform is zero-padded before an FFT. The FFT size is given by the following formula: FFT size = waveform size * padding. This parameter is used only when the acquisition span is less than the device instantaneous bandwidth. 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_frequency_definition(selector_string, frequency_definition)[source]

Configures whether you can specify the tones and intermod frequencies as either relative to the RF center frequency or as absolute frequencies.

Parameters:

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

  • frequency_definition (enums.IMFrequencyDefinition, int) –

    This parameter specifies whether you can specify the tones and intermod frequencies as either relative to the RF CENTER_FREQUENCY or as absolute frequencies. The default value is Relative.

    Name (Value)

    Description

    Relative (0)

    The tone and intermod frequencies are relative to the RF center frequency.

    Absolute (1)

    The tone and intermod frequencies are absolute frequencies. The measurement ignores the RF center frequency.

Returns:

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

Return type:

int

configure_fundamental_tones(selector_string, lower_tone_frequency, upper_tone_frequency)[source]

Configures the upper and lower frequencies in a two-tone input signal.

Parameters:

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

  • lower_tone_frequency (float) – This parameter specifies the frequency of the tone that has a lower frequency among the two tones in the input signal. This value is expressed in Hz. The default value is -1 MHz.

  • upper_tone_frequency (float) – This parameter specifies the frequency of the tone that has a higher frequency among the two tones in the input signal. This value is expressed in Hz. The default value is 1 MHz.

Returns:

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

Return type:

int

configure_intermod(selector_string, intermod_order, lower_intermod_frequency, upper_intermod_frequency, intermod_side, intermod_enabled)[source]

Configures the intermod order, intermod side, lower intermod frequency, and upper intermod frequency when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to False.

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

Parameters:

  • selector_string (string) –

    This parameter specifies a Selector String comprising of intermod number.

    Example:

    ”intermod0”

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

  • intermod_order (int) – This parameter specifies the order of the intermod. The default value is 3.

  • lower_intermod_frequency (float) – This parameter specifies the frequency of the lower intermodulation product. This value is expressed in Hz. The default value is -3 MHz.

  • upper_intermod_frequency (float) – This parameter specifies the frequency of the upper intermodulation product. This value is expressed in Hz. The default value is 3 MHz.

  • intermod_side (enums.IMIntermodSide, int) –

    This parameter specifies whether to measure intermodulation products corresponding to both lower and upper intermod frequencies or either one of them. The default value is Both.

    Name (Value)

    Description

    Lower (0)

    Measures the intermodulation product corresponding to the Lower Intermod Frequency parameter.

    Upper (1)

    Measures the intermodulation product corresponding to the Upper Intermod Frequency parameter.

    Both (2)

    Measures the intermodulation product corresponding to both Lower Intermod Frequency and Upper Intermod Frequency parameters.

  • intermod_enabled (enums.IMIntermodEnabled, int) –

    This parameter specifies whether to enable an intermod for the IM measurement. The default value is True.

    Name (Value)

    Description

    False (0)

    Disables an intermod for the IM measurement. The results for the disabled intermods are displayed as NaN.

    True (1)

    Enables an intermod for the IM measurement.

Returns:

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

Return type:

int

configure_intermod_array(selector_string, intermod_order, lower_intermod_frequency, upper_intermod_frequency, intermod_side, intermod_enabled)[source]

Configures the intermod order, intermod side, lower intermod frequency, and upper intermod frequency when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to False.

Parameters:

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

  • intermod_order (int) – This parameter specifies array of orders of the intermod. The default value is 3.

  • lower_intermod_frequency (float) – This parameter specifies an array of the frequencies of the lower intermodulation products. This value is expressed in Hz. The default value is -3 MHz.

  • upper_intermod_frequency (float) – This parameter specifies an array of frequencies of the upper intermodulation products. This value is expressed in Hz. The default value is 3 MHz.

  • intermod_side (enums.IMIntermodSide, int) –

    This parameter specifies whether to measure intermodulation products corresponding to both lower and upper intermod frequencies or either one of them. The default value is Both.

    Name (Value)

    Description

    Lower (0)

    Measures the intermodulation product corresponding to the Lower Intermod Frequency parameter.

    Upper (1)

    Measures the intermodulation product corresponding to the Upper Intermod Frequency parameter.

    Both (2)

    Measures the intermodulation product corresponding to the Lower Intermod Frequency and Upper Intermod Frequency parameters.

  • intermod_enabled (enums.IMIntermodEnabled, int) –

    This parameter specifies whether to enable an intermod for the IM measurement. The default value is True.

    Name (Value)

    Description

    False (0)

    Disables the intermod for the IM measurement. The results for the disabled intermods are displayed as NaN.

    True (1)

    Enables the intermod for the IM measurement.

Returns:

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

Return type:

int

configure_measurement_method(selector_string, measurement_method)[source]

Configures the method for performing the IM measurement.

Parameters:

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

  • measurement_method (enums.IMMeasurementMethod, int) –

    This parameter specifies the method for performing the IM measurement. The default value is Normal.

    Name (Value)

    Description

    Normal (0)

    The IM measurement acquires the spectrum using the same signal analyzer settings across frequency bands. Use this method when the fundamental tone separation is not large. Supported devices: PXIe-5644/5645/5646/5840/5841/5842/5830/5831/5832/5860, PXIe-5663/5665/5668.

    Dynamic Range (1)

    The IM measurement acquires a segmented spectrum using the signal analyzer specific optimizations for different frequency bands. The spectrum is acquired in segments, one per tone or intermod frequency to be measured. The span of each acquired spectral segment is equal to the frequency separation between the two input tones, or 1 MHz, whichever is smaller. Use this method to configure the IM measurement and the signal analyzer for maximum dynamic range instead of measurement speed. Supported devices: PXIe-5665/5668

    Segmented (2)

    Similar to the Dynamic Range method, this method also acquires a segmented spectrum, except that signal analyzer is not explicitly configured to provide maximum dynamic range. Use this method when the frequency separation of the two input tones is large and the measurement accuracy can be traded off for measurement speed. Supported devices: PXIe-5644/5645/5646/5840/5841/5842/5830/5831/5832, PXIe-5663/5665/5668

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_intermods(selector_string, number_of_intermods)[source]

Configures the number of intermods to measure when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to False.

Parameters:

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

  • number_of_intermods (int) – This parameter specifies the number of intermods to measure when you set the IM Auto Intermods Setup Enabled attribute to False. 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_rbw_filter(selector_string, rbw_auto, rbw, rbw_filter_type)[source]

Configures the RBW filter.

Parameters:

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

  • rbw_auto (enums.IMRbwFilterAutoBandwidth, int) –

    This parameter specifies whether the measurement computes the RBW. Refer to the RBW and Sweep Time section in the Spectral Measurements Concepts topic for more details on RBW and sweep time. The default value is True.

    Name (Value)

    Description

    False (0)

    The measurement uses the RBW that you specify in the RBW parameter.

    True (1)

    The measurement computes the RBW.

  • rbw (float) – This parameter specifies the bandwidth of the RBW filter used to sweep the acquired signal, when you set the RBW Auto parameter to False. This value is expressed in Hz. The default value is 10 kHz.

  • rbw_filter_type (enums.IMRbwFilterType, int) –

    This parameter specifies the response of the digital RBW filter. The default value is Gaussian.

    Name (Value)

    Description

    FFT Based (0)

    No RBW filtering is performed.

    Gaussian (1)

    An RBW filter with a Gaussian response is applied.

    Flat (2)

    An RBW filter with a flat response is applied.

Returns:

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

Return type:

int

configure_sweep_time(selector_string, sweep_time_auto, sweep_time_interval)[source]

Configures the sweep time.

Parameters:

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

  • sweep_time_auto (enums.IMSweepTimeAuto, int) –

    This parameter specifies whether the measurement computes the sweep time. The default value is True.

    Name (Value)

    Description

    False (0)

    The measurement uses the sweep time that you specify in the Sweep Time Interval parameter.

    True (1)

    The measurement computes the sweep time based on the value of the IM RBW attribute.

  • sweep_time_interval (float) – This parameter specifies the sweep time, in seconds, when you set the Sweep Time Auto parameter to False. The default value is 1 ms.

Returns:

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

Return type:

int

get_all_traces_enabled(selector_string)[source]

Gets whether to enable the traces to be stored and retrieved after performing the IM measurement.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (bool):

Specifies whether to enable the traces to be stored and retrieved after performing the IM measurement.

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_amplitude_correction_type(selector_string)[source]

Gets whether the amplitude of the frequency bins, used in the measurement, is corrected for external attenuation at the RF center frequency, or at the individual frequency bins. Use the nirfmxinstr.session.Session.configure_external_attenuation_table() method to configure the external attenuation table.

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 RF Center Frequency.

Name (Value)

Description

RF Center Frequency (0)

All the frequency bins in the spectrum are compensated with a single external attenuation value that corresponds to the RF center frequency.

Spectrum Frequency Bin (1)

An Individual frequency bin in the spectrum is compensated with the external attenuation value corresponding to that frequency.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.IMAmplitudeCorrectionType):

Specifies whether the amplitude of the frequency bins, used in the measurement, is corrected for external attenuation at the RF center frequency, or at the individual frequency bins. Use the nirfmxinstr.session.Session.configure_external_attenuation_table() method to configure the external attenuation table.

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_intermods_setup_enabled(selector_string)[source]

Gets whether the measurement computes the intermod frequencies or uses user-specified frequencies.

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 values that you specify for the IM Lower Intermod Freq and IM Upper Intermod Freq attributes.

True (1)

The measurement computes the intermod frequencies. The maximum number of intermods that you can measure is based on the value of the IM Max Intermod Order attribute.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.IMAutoIntermodsSetupEnabled):

Specifies whether the measurement computes the intermod frequencies or uses user-specified frequencies.

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_averaging_count(selector_string)[source]

Gets the number of acquisitions used for averaging when you set the AVERAGING_ENABLED attribute to True.

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 (int):

Specifies the number of acquisitions used for averaging when you set the AVERAGING_ENABLED attribute to True.

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_averaging_enabled(selector_string)[source]

Gets whether to enable averaging for the IM measurement.

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

Name (Value)

Description

False (0)

The measurement is performed on a single acquisition.

True (1)

The IM measurement uses the IM Averaging Count attribute as the number of acquisitions over which the IM measurement is averaged.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.IMAveragingEnabled):

Specifies whether to enable averaging for the IM measurement.

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_averaging_type(selector_string)[source]

Gets the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for the IM measurement.

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

Name (Value)

Description

RMS (0)

The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.

Log (1)

The power spectrum is averaged in a logarithmic scale.

Scalar (2)

The square root of the power spectrum is averaged.

Max (3)

The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.

Min (4)

The least power in the spectrum at each frequency bin is retained from one acquisition to the next.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.IMAveragingType):

Specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for the IM measurement.

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_far_if_output_power_offset(selector_string)[source]

Gets the offset by which to adjust the IF output power level for the intermods that are far from the carrier channel to improve the dynamic range of the signal analyzer. This value is expressed in dB. This attribute is used only if you set the MEASUREMENT_METHOD attribute to Dynamic Range and the IF_OUTPUT_POWER_OFFSET_AUTO attribute to False.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the offset by which to adjust the IF output power level for the intermods that are far from the carrier channel to improve the dynamic range of the signal analyzer. This value is expressed in dB. This attribute is used only if you set the MEASUREMENT_METHOD attribute to Dynamic Range and the IF_OUTPUT_POWER_OFFSET_AUTO attribute to False.

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_fft_padding(selector_string)[source]

Gets the factor by which the time-domain waveform is zero-padded before an FFT. The FFT size is given by the following formula:

FFT size = waveform size * padding

This attribute is used only when the acquisition span is less than the device instantaneous bandwidth.

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 (float):

Specifies the factor by which the time-domain waveform is zero-padded before an FFT. The FFT size is given by the following formula:

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_fft_window(selector_string)[source]

Gets the FFT window type to use to reduce spectral leakage.

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

Name (Value)

Description

None (0)

Analyzes transients for which duration is shorter than the window length. You can also use this window type to separate two tones with frequencies close to each other but with almost equal amplitudes.

Flat Top (1)

Measures single-tone amplitudes accurately.

Hanning (2)

Analyzes transients for which duration is longer than the window length. You can also use this window type to provide better frequency resolution for noise measurements.

Hamming (3)

Analyzes closely-spaced sine waves.

Gaussian (4)

Provides a good balance of spectral leakage, frequency resolution, and amplitude attenuation. This windowing is useful for time-frequency analysis.

Blackman (5)

Analyzes single tone because it has a low maximum side lobe level and a high side lobe roll-off rate.

Blackman-Harris (6)

Useful as a good general purpose window, having side lobe rejection greater than 90 dB and having a moderately wide main lobe.

Kaiser-Bessel (7)

Separates two tones with frequencies close to each other but with widely-differing amplitudes.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.IMFftWindow):

Specifies the FFT window type to use to reduce spectral leakage.

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_frequency_definition(selector_string)[source]

Gets whether the tones and intermod frequencies are relative to the RF CENTER_FREQUENCY, or are absolute frequencies.

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 tone and intermod frequencies are relative to the RF center frequency.

Absolute (1)

The tone and intermod frequencies are absolute frequencies. The measurement ignores the RF center frequency.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.IMFrequencyDefinition):

Specifies whether the tones and intermod frequencies are relative to the RF CENTER_FREQUENCY, or are absolute frequencies.

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_fundamental_lower_tone_frequency(selector_string)[source]

Gets the frequency of the tone that has a lower frequency among the two tones in the input signal. This value is expressed in Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the frequency of the tone that has a lower frequency among the two tones in the input signal. This value is expressed in Hz.

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_fundamental_upper_tone_frequency(selector_string)[source]

Gets the frequency of the tone that has a higher frequency among the two tones in the input signal. This value is expressed in Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the frequency of the tone that has a higher frequency among the two tones in the input signal. This value is expressed in Hz.

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_if_output_power_offset_auto(selector_string)[source]

Gets whether the measurement computes an IF output power level offset for the intermods to maximize the dynamic range of the signal analyzer. This attribute is used only if you set the MEASUREMENT_METHOD attribute to Dynamic Range.

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 sets the IF output power level offset using the values of the IM Near IF Output Power Offset and IM Far IF Output Power Offset attributes.

True (1)

The measurement computes an IF output power level offset for the intermods to improve the dynamic range of the IM measurement.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.IMIFOutputPowerOffsetAuto):

Specifies whether the measurement computes an IF output power level offset for the intermods to maximize the dynamic range of the signal analyzer. This attribute is used only if you set the MEASUREMENT_METHOD attribute to Dynamic Range.

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_intermod_enabled(selector_string)[source]

Gets whether to enable an intermod for the IM measurement. This attribute is not used when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to True.

Use “intermod<n>” as the Selector String to configure or read this attribute.

The default value is True.

Name (Value)

Description

False (0)

Disables an intermod for the IM measurement. The results for the disabled intermods are displayed as NaN.

True (1)

Enables an intermod for the IM measurement.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.IMIntermodEnabled):

Specifies whether to enable an intermod for the IM measurement. This attribute is not used when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to True.

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_intermod_order(selector_string)[source]

Gets the order of the intermod. This attribute is not used when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to True.

Use “intermod<n>” as the Selector String to configure or read this attribute.

The default value is 3.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the order of the intermod. This attribute is not used when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to True.

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_intermod_side(selector_string)[source]

Gets whether to measure intermodulation products corresponding to both lower and upper intermod frequencies or either one of them. This attribute is not used when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to True.

Use “intermod<n>” as the Selector String to configure or read this attribute.

The default value is Both.

Name (Value)

Description

Lower (0)

Measures the intermodulation product corresponding to the IM Lower Intermod Freq attribute.

Upper (1)

Measures the intermodulation product corresponding to the IM Upper Intermod Freq attribute.

Both (2)

Measures the intermodulation product corresponding to both IM Lower Intermod Freq and IM Upper Intermod Freq attributes.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.IMIntermodSide):

Specifies whether to measure intermodulation products corresponding to both lower and upper intermod frequencies or either one of them. This attribute is not used when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to True.

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_local_peak_search_enabled(selector_string)[source]

Gets whether to enable a local peak search around the tone or intermod frequencies to account for small frequency offsets.

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 returns the power at the tone and intermod frequencies.

True (1)

The measurement performs a local peak search around the tone and intermod frequencies to return the peak power.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.IMLocalPeakSearchEnabled):

Specifies whether to enable a local peak search around the tone or intermod frequencies to account for small frequency offsets.

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_lower_intermod_frequency(selector_string)[source]

Gets the frequency of the lower intermodulation product. This value is expressed in Hz. This attribute is not used when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to True.

Use “intermod<n>” as the Selector String to configure or read this attribute.

The default value is -3 MHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the frequency of the lower intermodulation product. This value is expressed in Hz. This attribute is not used when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to True.

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_maximum_intermod_order(selector_string)[source]

Gets the order up to which the RFmx driver measures odd order intermodulation products when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to True. The lower and upper intermodulation products are measured for each order.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the order up to which the RFmx driver measures odd order intermodulation products when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to True. The lower and upper intermodulation products are measured for each order.

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_measurement_enabled(selector_string)[source]

Gets whether to enable the IM measurement.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (bool):

Specifies whether to enable the IM measurement.

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_measurement_method(selector_string)[source]

Gets the method used to perform the IM measurement.

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

Name (Value)

Description

Normal (0)

The IM measurement acquires the spectrum using the same signal analyzer settings across frequency bands. Use this method when the fundamental tone separation is not large. Supported devices: PXIe-5644/5645/5646/5840/5841/5842/5860/5830/5831/5832, PXIe-5663/5665/5668.

Dynamic Range (1)

The IM measurement acquires a segmented spectrum using the signal analyzer specific optimizations for different frequency bands. The spectrum is acquired in segments, one per tone or intermod frequency to be measured. The span of each acquired spectral segment is equal to the frequency separation between the two input tones, or 1 MHz, whichever is smaller. Use this method to configure the IM measurement and the signal analyzer for maximum dynamic range instead of measurement speed. Supported devices: PXIe-5665/5668.

Segmented (2)

Similar to the Dynamic Range method, this method also acquires a segmented spectrum, except that signal analyzer is not explicitly configured to provide maximum dynamic range. Use this method when the frequency separation of the two input tones is large and the measurement accuracy can be traded off for measurement speed. Supported devices: PXIe-5644/5645/5646/5840/5841/5842/5860/5830/5831/5832, PXIe-5663/5665/5668.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.IMMeasurementMethod):

Specifies the method used to perform the IM measurement.

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_near_if_output_power_offset(selector_string)[source]

Gets the offset by which to adjust the IF output power level for the intermods near the carrier channel to improve the dynamic range of the signal analyzer. This value is expressed in dB. This attribute is used only if you set the MEASUREMENT_METHOD attribute to Dynamic Range and the IF_OUTPUT_POWER_OFFSET_AUTO attribute to False.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the offset by which to adjust the IF output power level for the intermods near the carrier channel to improve the dynamic range of the signal analyzer. This value is expressed in dB. This attribute is used only if you set the MEASUREMENT_METHOD attribute to Dynamic Range and the IF_OUTPUT_POWER_OFFSET_AUTO attribute to False.

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_analysis_threads(selector_string)[source]

Gets the maximum number of threads used for parallelism for the IM measurement.

The number of threads can range from 1 to the number of physical cores. The number of threads you set may not be used in calculations. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations.

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 maximum number of threads used for parallelism for the IM measurement.

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_intermods(selector_string)[source]

Gets the number of intermods to measure when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to False.

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 intermods to measure when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to False.

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_rbw_filter_auto_bandwidth(selector_string)[source]

Gets whether the measurement computes the RBW.

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 RBW that you specify in the IM RBW attribute.

True (1)

The measurement computes the RBW.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.IMRbwFilterAutoBandwidth):

Specifies whether the measurement computes the RBW.

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_rbw_filter_bandwidth(selector_string)[source]

Gets the bandwidth of the RBW filter used to sweep the acquired signal, when you set the RBW_FILTER_AUTO_BANDWIDTH attribute to False. This value is expressed in Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the bandwidth of the RBW filter used to sweep the acquired signal, when you set the RBW_FILTER_AUTO_BANDWIDTH attribute to False. This value is expressed in Hz.

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_rbw_filter_type(selector_string)[source]

Gets the response of the digital RBW filter.

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

Name (Value)

Description

FFT Based (0)

No RBW filtering is performed.

Gaussian (1)

An RBW filter with a Gaussian response is applied.

Flat (2)

An RBW filter with a flat response is applied.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.IMRbwFilterType):

Specifies the response of the digital RBW filter.

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_sweep_time_auto(selector_string)[source]

Gets whether the measurement computes the sweep time.

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 sweep time that you specify in the IM Sweep Time attribute.

True (1)

The measurement computes the sweep time based on the value of the IM RBW attribute.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.IMSweepTimeAuto):

Specifies whether the measurement computes the sweep time.

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_sweep_time_interval(selector_string)[source]

Gets the sweep time when you set the SWEEP_TIME_AUTO attribute to False. 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 0.001.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the sweep time when you set the SWEEP_TIME_AUTO attribute to False. 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_upper_intermod_frequency(selector_string)[source]

Gets the frequency of the upper intermodulation product. This value is expressed in Hz. This attribute is not used when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to True.

Use “intermod<n>” as the Selector String to configure or read this attribute.

The default value is 3 MHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the frequency of the upper intermodulation product. This value is expressed in Hz. This attribute is not used when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to True.

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)

set_all_traces_enabled(selector_string, value)[source]

Sets whether to enable the traces to be stored and retrieved after performing the IM measurement.

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

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (bool) – Specifies whether to enable the traces to be stored and retrieved after performing the IM measurement.

Returns:

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

Return type:

int

set_amplitude_correction_type(selector_string, value)[source]

Sets whether the amplitude of the frequency bins, used in the measurement, is corrected for external attenuation at the RF center frequency, or at the individual frequency bins. Use the nirfmxinstr.session.Session.configure_external_attenuation_table() method to configure the external attenuation table.

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 RF Center Frequency.

Name (Value)

Description

RF Center Frequency (0)

All the frequency bins in the spectrum are compensated with a single external attenuation value that corresponds to the RF center frequency.

Spectrum Frequency Bin (1)

An Individual frequency bin in the spectrum is compensated with the external attenuation value corresponding to that frequency.
Parameters:
Returns:

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

Return type:

int

set_auto_intermods_setup_enabled(selector_string, value)[source]

Sets whether the measurement computes the intermod frequencies or uses user-specified frequencies.

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 values that you specify for the IM Lower Intermod Freq and IM Upper Intermod Freq attributes.

True (1)

The measurement computes the intermod frequencies. The maximum number of intermods that you can measure is based on the value of the IM Max Intermod Order attribute.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.IMAutoIntermodsSetupEnabled, int) – Specifies whether the measurement computes the intermod frequencies or uses user-specified frequencies.

Returns:

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

Return type:

int

set_averaging_count(selector_string, value)[source]

Sets the number of acquisitions used for averaging when you set the AVERAGING_ENABLED attribute to True.

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 (int) – Specifies the number of acquisitions used for averaging when you set the AVERAGING_ENABLED attribute to True.

Returns:

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

Return type:

int

set_averaging_enabled(selector_string, value)[source]

Sets whether to enable averaging for the IM measurement.

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

Name (Value)

Description

False (0)

The measurement is performed on a single acquisition.

True (1)

The IM measurement uses the IM Averaging Count attribute as the number of acquisitions over which the IM measurement is averaged.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.IMAveragingEnabled, int) – Specifies whether to enable averaging for the IM measurement.

Returns:

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

Return type:

int

set_averaging_type(selector_string, value)[source]

Sets the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for the IM measurement.

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

Name (Value)

Description

RMS (0)

The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.

Log (1)

The power spectrum is averaged in a logarithmic scale.

Scalar (2)

The square root of the power spectrum is averaged.

Max (3)

The peak power in the spectrum at each frequency bin is retained from one acquisition to the next.

Min (4)

The least power in the spectrum at each frequency bin is retained from one acquisition to the next.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.IMAveragingType, int) – Specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for the IM measurement.

Returns:

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

Return type:

int

set_far_if_output_power_offset(selector_string, value)[source]

Sets the offset by which to adjust the IF output power level for the intermods that are far from the carrier channel to improve the dynamic range of the signal analyzer. This value is expressed in dB. This attribute is used only if you set the MEASUREMENT_METHOD attribute to Dynamic Range and the IF_OUTPUT_POWER_OFFSET_AUTO attribute to False.

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

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the offset by which to adjust the IF output power level for the intermods that are far from the carrier channel to improve the dynamic range of the signal analyzer. This value is expressed in dB. This attribute is used only if you set the MEASUREMENT_METHOD attribute to Dynamic Range and the IF_OUTPUT_POWER_OFFSET_AUTO attribute to False.

Returns:

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

Return type:

int

set_fft_padding(selector_string, value)[source]

Sets the factor by which the time-domain waveform is zero-padded before an FFT. The FFT size is given by the following formula:

FFT size = waveform size * padding

This attribute is used only when the acquisition span is less than the device instantaneous bandwidth.

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 (float) – Specifies the factor by which the time-domain waveform is zero-padded before an FFT. The FFT size is given by the following formula:

Returns:

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

Return type:

int

set_fft_window(selector_string, value)[source]

Sets the FFT window type to use to reduce spectral leakage.

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

Name (Value)

Description

None (0)

Analyzes transients for which duration is shorter than the window length. You can also use this window type to separate two tones with frequencies close to each other but with almost equal amplitudes.

Flat Top (1)

Measures single-tone amplitudes accurately.

Hanning (2)

Analyzes transients for which duration is longer than the window length. You can also use this window type to provide better frequency resolution for noise measurements.

Hamming (3)

Analyzes closely-spaced sine waves.

Gaussian (4)

Provides a good balance of spectral leakage, frequency resolution, and amplitude attenuation. This windowing is useful for time-frequency analysis.

Blackman (5)

Analyzes single tone because it has a low maximum side lobe level and a high side lobe roll-off rate.

Blackman-Harris (6)

Useful as a good general purpose window, having side lobe rejection greater than 90 dB and having a moderately wide main lobe.

Kaiser-Bessel (7)

Separates two tones with frequencies close to each other but with widely-differing amplitudes.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.IMFftWindow, int) – Specifies the FFT window type to use to reduce spectral leakage.

Returns:

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

Return type:

int

set_frequency_definition(selector_string, value)[source]

Sets whether the tones and intermod frequencies are relative to the RF CENTER_FREQUENCY, or are absolute frequencies.

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 tone and intermod frequencies are relative to the RF center frequency.

Absolute (1)

The tone and intermod frequencies are absolute frequencies. The measurement ignores the RF center frequency.
Parameters:
Returns:

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

Return type:

int

set_fundamental_lower_tone_frequency(selector_string, value)[source]

Sets the frequency of the tone that has a lower frequency among the two tones in the input signal. This value is expressed in Hz.

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

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the frequency of the tone that has a lower frequency among the two tones in the input signal. This value is expressed in Hz.

Returns:

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

Return type:

int

set_fundamental_upper_tone_frequency(selector_string, value)[source]

Sets the frequency of the tone that has a higher frequency among the two tones in the input signal. This value is expressed in Hz.

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

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the frequency of the tone that has a higher frequency among the two tones in the input signal. This value is expressed in Hz.

Returns:

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

Return type:

int

set_if_output_power_offset_auto(selector_string, value)[source]

Sets whether the measurement computes an IF output power level offset for the intermods to maximize the dynamic range of the signal analyzer. This attribute is used only if you set the MEASUREMENT_METHOD attribute to Dynamic Range.

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 sets the IF output power level offset using the values of the IM Near IF Output Power Offset and IM Far IF Output Power Offset attributes.

True (1)

The measurement computes an IF output power level offset for the intermods to improve the dynamic range of the IM measurement.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.IMIFOutputPowerOffsetAuto, int) – Specifies whether the measurement computes an IF output power level offset for the intermods to maximize the dynamic range of the signal analyzer. This attribute is used only if you set the MEASUREMENT_METHOD attribute to Dynamic Range.

Returns:

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

Return type:

int

set_intermod_enabled(selector_string, value)[source]

Sets whether to enable an intermod for the IM measurement. This attribute is not used when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to True.

Use “intermod<n>” as the Selector String to configure or read this attribute.

The default value is True.

Name (Value)

Description

False (0)

Disables an intermod for the IM measurement. The results for the disabled intermods are displayed as NaN.

True (1)

Enables an intermod for the IM measurement.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.IMIntermodEnabled, int) – Specifies whether to enable an intermod for the IM measurement. This attribute is not used when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to True.

Returns:

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

Return type:

int

set_intermod_order(selector_string, value)[source]

Sets the order of the intermod. This attribute is not used when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to True.

Use “intermod<n>” as the Selector String to configure or read this attribute.

The default value is 3.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the order of the intermod. This attribute is not used when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to True.

Returns:

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

Return type:

int

set_intermod_side(selector_string, value)[source]

Sets whether to measure intermodulation products corresponding to both lower and upper intermod frequencies or either one of them. This attribute is not used when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to True.

Use “intermod<n>” as the Selector String to configure or read this attribute.

The default value is Both.

Name (Value)

Description

Lower (0)

Measures the intermodulation product corresponding to the IM Lower Intermod Freq attribute.

Upper (1)

Measures the intermodulation product corresponding to the IM Upper Intermod Freq attribute.

Both (2)

Measures the intermodulation product corresponding to both IM Lower Intermod Freq and IM Upper Intermod Freq attributes.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.IMIntermodSide, int) – Specifies whether to measure intermodulation products corresponding to both lower and upper intermod frequencies or either one of them. This attribute is not used when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to True.

Returns:

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

Return type:

int

set_local_peak_search_enabled(selector_string, value)[source]

Sets whether to enable a local peak search around the tone or intermod frequencies to account for small frequency offsets.

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 returns the power at the tone and intermod frequencies.

True (1)

The measurement performs a local peak search around the tone and intermod frequencies to return the peak power.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.IMLocalPeakSearchEnabled, int) – Specifies whether to enable a local peak search around the tone or intermod frequencies to account for small frequency offsets.

Returns:

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

Return type:

int

set_lower_intermod_frequency(selector_string, value)[source]

Sets the frequency of the lower intermodulation product. This value is expressed in Hz. This attribute is not used when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to True.

Use “intermod<n>” as the Selector String to configure or read this attribute.

The default value is -3 MHz.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the frequency of the lower intermodulation product. This value is expressed in Hz. This attribute is not used when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to True.

Returns:

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

Return type:

int

set_maximum_intermod_order(selector_string, value)[source]

Sets the order up to which the RFmx driver measures odd order intermodulation products when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to True. The lower and upper intermodulation products are measured for each order.

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

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the order up to which the RFmx driver measures odd order intermodulation products when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to True. The lower and upper intermodulation products are measured for each order.

Returns:

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

Return type:

int

set_measurement_enabled(selector_string, value)[source]

Sets whether to enable the IM measurement.

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

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (bool) – Specifies whether to enable the IM measurement.

Returns:

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

Return type:

int

set_measurement_method(selector_string, value)[source]

Sets the method used to perform the IM measurement.

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

Name (Value)

Description

Normal (0)

The IM measurement acquires the spectrum using the same signal analyzer settings across frequency bands. Use this method when the fundamental tone separation is not large. Supported devices: PXIe-5644/5645/5646/5840/5841/5842/5860/5830/5831/5832, PXIe-5663/5665/5668.

Dynamic Range (1)

The IM measurement acquires a segmented spectrum using the signal analyzer specific optimizations for different frequency bands. The spectrum is acquired in segments, one per tone or intermod frequency to be measured. The span of each acquired spectral segment is equal to the frequency separation between the two input tones, or 1 MHz, whichever is smaller. Use this method to configure the IM measurement and the signal analyzer for maximum dynamic range instead of measurement speed. Supported devices: PXIe-5665/5668.

Segmented (2)

Similar to the Dynamic Range method, this method also acquires a segmented spectrum, except that signal analyzer is not explicitly configured to provide maximum dynamic range. Use this method when the frequency separation of the two input tones is large and the measurement accuracy can be traded off for measurement speed. Supported devices: PXIe-5644/5645/5646/5840/5841/5842/5860/5830/5831/5832, PXIe-5663/5665/5668.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.IMMeasurementMethod, int) – Specifies the method used to perform the IM measurement.

Returns:

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

Return type:

int

set_near_if_output_power_offset(selector_string, value)[source]

Sets the offset by which to adjust the IF output power level for the intermods near the carrier channel to improve the dynamic range of the signal analyzer. This value is expressed in dB. This attribute is used only if you set the MEASUREMENT_METHOD attribute to Dynamic Range and the IF_OUTPUT_POWER_OFFSET_AUTO attribute to False.

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

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the offset by which to adjust the IF output power level for the intermods near the carrier channel to improve the dynamic range of the signal analyzer. This value is expressed in dB. This attribute is used only if you set the MEASUREMENT_METHOD attribute to Dynamic Range and the IF_OUTPUT_POWER_OFFSET_AUTO attribute to False.

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_analysis_threads(selector_string, value)[source]

Sets the maximum number of threads used for parallelism for the IM measurement.

The number of threads can range from 1 to the number of physical cores. The number of threads you set may not be used in calculations. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations.

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 maximum number of threads used for parallelism for the IM measurement.

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_intermods(selector_string, value)[source]

Sets the number of intermods to measure when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to False.

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 intermods to measure when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to False.

Returns:

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

Return type:

int

set_rbw_filter_auto_bandwidth(selector_string, value)[source]

Sets whether the measurement computes the RBW.

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 RBW that you specify in the IM RBW attribute.

True (1)

The measurement computes the RBW.
Parameters:
Returns:

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

Return type:

int

set_rbw_filter_bandwidth(selector_string, value)[source]

Sets the bandwidth of the RBW filter used to sweep the acquired signal, when you set the RBW_FILTER_AUTO_BANDWIDTH attribute to False. This value is expressed in Hz.

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

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the bandwidth of the RBW filter used to sweep the acquired signal, when you set the RBW_FILTER_AUTO_BANDWIDTH attribute to False. This value is expressed in Hz.

Returns:

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

Return type:

int

set_rbw_filter_type(selector_string, value)[source]

Sets the response of the digital RBW filter.

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

Name (Value)

Description

FFT Based (0)

No RBW filtering is performed.

Gaussian (1)

An RBW filter with a Gaussian response is applied.

Flat (2)

An RBW filter with a flat response is applied.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.IMRbwFilterType, int) – Specifies the response of the digital RBW filter.

Returns:

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

Return type:

int

set_sweep_time_auto(selector_string, value)[source]

Sets whether the measurement computes the sweep time.

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 sweep time that you specify in the IM Sweep Time attribute.

True (1)

The measurement computes the sweep time based on the value of the IM RBW attribute.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.IMSweepTimeAuto, int) – Specifies whether the measurement computes the sweep time.

Returns:

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

Return type:

int

set_sweep_time_interval(selector_string, value)[source]

Sets the sweep time when you set the SWEEP_TIME_AUTO attribute to False. 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 0.001.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the sweep time when you set the SWEEP_TIME_AUTO attribute to False. 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_upper_intermod_frequency(selector_string, value)[source]

Sets the frequency of the upper intermodulation product. This value is expressed in Hz. This attribute is not used when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to True.

Use “intermod<n>” as the Selector String to configure or read this attribute.

The default value is 3 MHz.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the frequency of the upper intermodulation product. This value is expressed in Hz. This attribute is not used when you set the AUTO_INTERMODS_SETUP_ENABLED attribute to True.

Returns:

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

Return type:

int