SpurConfiguration

Provides methods to configure the Spur measurement.

class nirfmxspecan.spur_configuration.SpurConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the Spur measurement.

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

Configures averaging for the spurious emission (Spur) measurement. Supported devices: PXIe-5665, PXIe-5668

Parameters:

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

averaging_enabled (enums.SpurAveragingEnabled, 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.SpurAveragingType, int) –

This parameter specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for the measurement. Refer to the Averaging section of the Spectral Measurements Concepts topic for more information about averaging types. 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.

Returns:

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

Return type:

int

configure_fft_window_type(selector_string, fft_window)[source]

Configures the FFT window to obtain a spectrum for the spurious emission (Spur) measurement. Supported devices: PXIe-5665, PXIe-5668

Parameters:

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

fft_window (enums.SpurFftWindow, 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.
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 90dB and having a moderately wide main lobe.
Kaiser-Bessel (7)	Separates two tones with frequencies close to each other but with widely-differing amplitudes.

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_ranges(selector_string, number_of_ranges)[source]

Configures the number of ranges.

** Supported devices: ** PXIe-5665, PXIe-5668

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
number_of_ranges (int) – This parameter specifies the number of ranges. 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_range_absolute_limit(selector_string, absolute_limit_mode, absolute_limit_start, absolute_limit_stop)[source]

Configures the absolute power limits corresponding to the beginning and end of the frequency range. Use “range<n>” as the selector string to configure this method. Supported devices: PXIe-5665, PXIe-5668

Parameters:

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

Example:

”range0”

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

absolute_limit_mode (enums.SpurAbsoluteLimitMode, int) –

This parameter specifies whether the absolute limit threshold is a flat line or a line with a slope. The default value is Couple.

Name (Value)	Description
Manual (0)	The line specified by the Spur Range Abs Limit Start and Spur Range Abs Limit Stop attribute values as the two ends is considered as the mask.
Couple (1)	The two ends of the line are coupled to the value of the Spur Range Abs Limit Start attribute.

absolute_limit_start (float) – This parameter specifies the absolute power limit, in dBm, corresponding to the beginning of the frequency range. The value of this parameter is also set as the absolute power limit for the range when you set the Absolute Limit Mode parameter to Couple. The default value is -10.
absolute_limit_stop (float) – This parameter specifies the absolute power limit, in dBm, corresponding to the end of the frequency range. This parameter is ignored when you set the Absolute Limit Mode parameter to Couple. The default value is -10.

Returns:

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

Return type:

int

configure_range_absolute_limit_array(selector_string, absolute_limit_mode, absolute_limit_start, absolute_limit_stop)[source]

Configures the absolute power limits corresponding to the beginning and end of the frequency range and specifies whether the absolute limit threshold is a flat line or a line with a slope. Supported devices: PXIe-5665, PXIe-5668

Parameters:

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

absolute_limit_mode (enums.SpurAbsoluteLimitMode, int) –

This parameter specifies whether the absolute limit threshold is a flat line or a line with a slope. The default value is Couple.

Name (Value)	Description
Manual (0)	The line specified by the Spur Range Abs Limit Start and Spur Range Abs Limit Stop attribute values as the two ends is considered as the mask.
Couple (1)	The two ends of the line are coupled to the value of the Spur Range Abs Limit Start attribute.

absolute_limit_start (float) – This parameter specifies the array of absolute power limits, in dBm, corresponding to the beginning of the frequency range. The value of this parameter is also set as the absolute power limit for the range when you set the Absolute Limit Mode parameter to Couple. The default value is -10.
absolute_limit_stop (float) – This parameter specifies the array of absolute power limits, in dBm, corresponding to the end of the frequency range. This parameter is ignored when you set the Absolute Limit Mode parameter to Couple. The default value is -10.

Returns:

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

Return type:

int

configure_range_detector(selector_string, detector_type, detector_points)[source]

Configures the detector settings including detector type and the number of points to be detected. Use “range<n>” as the selector string to configure this method.

Parameters:

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

Example:

”range0”

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

detector_type (enums.SpurRangeDetectorType, int) –

This parameter specifies the type of detector to be used. The default value is None. Refer to Spectral Measurements Concepts topic for more information on detectors.

Name (Value)	Description
None (0)	The detector is disabled.
Sample (1)	The middle sample in the bucket is detected.
Normal (2)	The maximum value of the samples within the bucket is detected if the signal only rises or if the signal only falls. If the signal, within a bucket, both rises and falls, then the maximum and minimum values of the samples are detected in alternate buckets.
Peak (3)	The maximum value of the samples in the bucket is detected.
Negative Peak (4)	The minimum value of the samples in the bucket is detected.
Average RMS (5)	The average RMS of all the samples in the bucket is detected.
Average Voltage (6)	The average voltage of all the samples in the bucket is detected.
Average Log (7)	The average log of all the samples in the bucket is detected.

detector_points (int) – This parameter specifies the number of points after the detector is applied. The default value is 1001.

Returns:

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

Return type:

int

configure_range_detector_array(selector_string, detector_type, detector_points)[source]

Configures an array of the detector settings including detector type and the number of points to be detected.

Refer to Spectral Measurements Concepts topic for more information on detector types.

Parameters:

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

detector_type (enums.SpurRangeDetectorType, int) –

This parameter specifies the type of detector to be used. The default value is None. Refer to Spectral Measurements Concepts topic for more information on detectors.

Name (Value)	Description
None (0)	The detector is disabled.
Sample (1)	The middle sample in the bucket is detected.
Normal (2)	The maximum value of the samples within the bucket is detected if the signal only rises or if the signal only falls. If the signal, within a bucket, both rises and falls, then the maximum and minimum values of the samples are detected in alternate buckets.
Peak (3)	The maximum value of the samples in the bucket is detected.
Negative Peak (4)	The minimum value of the samples in the bucket is detected.
Average RMS (5)	The average RMS of all the samples in the bucket is detected.
Average Voltage (6)	The average voltage of all the samples in the bucket is detected.
Average Log (7)	The average log of all the samples in the bucket is detected.

detector_points (int) – This parameter specifies an array of the number of points after the detector 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_range_frequency(selector_string, start_frequency, stop_frequency, range_enabled)[source]

Configures the frequency start and stop values of the range. Use “range<n>” as the selector string to configure this method. Supported devices: PXIe-5665, PXIe-5668

Parameters:

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

Example:

”range0”

You can use the build_range_string() method to build the selector string.
start_frequency (float) – This parameter specifies the start of the frequency range, in Hz, for the measurement. The default value is 500 MHz.
stop_frequency (float) – This parameter specifies the stop of the frequency range, in Hz, for the measurement. The default value is 1.5 GHz.
range_enabled (enums.SpurRangeEnabled, int) –
This parameter specifies whether to measure the Spurs in the frequency range. The default value is True.

Name (Value)

Description

False (0)

Disables the acquisition of the frequency range.

True (1)

Enables measurement of Spurs in the frequency range.

Returns:

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

Return type:

int

configure_range_frequency_array(selector_string, start_frequency, stop_frequency, range_enabled)[source]

Configures the frequency start and stop values and specifies whether to enable measurement of the spurious emissions (Spur) in the frequency range. Supported devices: PXIe-5665, PXIe-5668

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
start_frequency (float) – This parameter specifies the array of start frequencies of the frequency range, in Hz, for the measurement. The default value is 500 MHz.
stop_frequency (float) – This parameter specifies the array of stop frequencies of the frequency range, in Hz, for the measurement. The default value is 1.5 GHz.
range_enabled (enums.SpurRangeEnabled, int) –
This parameter specifies whether to measure the Spur in the frequency range. The default value is True.

Name (Value)

Description

False (0)

Disables the acquisition of the frequency range.

True (1)

Enables measurement of Spurs in the frequency range.

Returns:

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

Return type:

int

configure_range_number_of_spurs_to_report(selector_string, number_of_spurs_to_report)[source]

Specifies the number of Spurs that the measurement should report in the frequency range.

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

** Supported devices: ** PXIe-5665, PXIe-5668

Parameters:

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

Example:

”range0”

You can use the build_range_string() method to build the selector string.
number_of_spurs_to_report (int) – This parameter specifies the number of Spurs that the measurement should report in the frequency range. The default value is 10.

Returns:

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

Return type:

int

configure_range_number_of_spurs_to_report_array(selector_string, number_of_spurs_to_report)[source]

Specifies the number of Spurs that the measurement should report in the frequency range.

** Supported devices: ** PXIe-5665, PXIe-5668

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
number_of_spurs_to_report (int) – This parameter specifies the array of number of Spurs that the measurement should report in the frequency range. The default value is 10.

Returns:

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

Return type:

int

configure_range_peak_criteria(selector_string, threshold, excursion)[source]

Configures the peak threshold and peak excursion criteria which a peak should meet to be classified as a spurious emission (Spur).

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

** Supported devices: ** PXIe-5665, PXIe-5668

Parameters:

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

Example:

”range0”

You can use the build_range_string() method to build the selector string.
threshold (float) – This parameter specifies the threshold level, in dBm, above which the measurement detects spurs in the range. The default value is -200.
excursion (float) –
This parameter specifies the peak excursion to be used when spur detection is performed. The default value is 6.

Refer to the Phase Noise topic for more information on spur removal.

Returns:

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

Return type:

int

configure_range_peak_criteria_array(selector_string, threshold, excursion)[source]

Configures arrays of peak threshold and peak excursion criteria which a peak should meet to be classified as a spurious emission (Spur).

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
threshold (float) – This parameter specifies the array of threshold levels, in dBm, above which the measurement detects spurs in the range. The default value is -200.
excursion (float) – This parameter specifies the array of peak excursion values, in dB, used to find the spurs in the spectrum. The signal should rise and fall by at least the peak excursion value, above the threshold, to be considered as a spur. The default value is 0.

Returns:

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

Return type:

int

configure_range_rbw_array(selector_string, rbw_auto, rbw, rbw_filter_type)[source]

Configures the resolution bandwidth (RBW) filter. Supported devices: PXIe-5665, PXIe-5668

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
rbw_auto (enums.SpurRbwAutoBandwidth, int) –
This parameter specifies whether the measurement computes the RBW. Refer to the Spectrum topic for 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 array of bandwidths, in Hz, of the RBW filter used to sweep the acquired range, when you set the RBW Auto parameter to False. The default value is 10 kHz.
rbw_filter_type (enums.SpurRbwFilterType, int) –
This parameter specifies the shape 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_range_rbw_filter(selector_string, rbw_auto, rbw, rbw_filter_type)[source]

Configures the resolution bandwidth (RBW) filter. Use “range<n>” as the selector string to configure this method. Supported devices: PXIe-5665, PXIe-5668

Parameters:

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

Example:

”range0”

You can use the build_range_string() method to build the selector string.
rbw_auto (enums.SpurRbwAutoBandwidth, 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, in Hz, of the RBW filter used to sweep the acquired offset segment, when you set the RBW Auto parameter to False. The default value is 10 kHz.
rbw_filter_type (enums.SpurRbwFilterType, 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_range_relative_attenuation(selector_string, relative_attenuation)[source]

Specifies the attenuation, in dB, relative to the external attenuation. Use “range<n>” as the selector string to configure this method. Supported devices: PXIe-5665, PXIe-5668

Parameters:

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

Example:

”range0”

You can use the build_range_string() method to build the selector string.
relative_attenuation (float) – This parameter specifies the attenuation, in dB, relative to the external attenuation. Use this parameter to compensate for variations in external attenuation when the offset channels are spread wide in frequency. The default value is 0.

Returns:

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

Return type:

int

configure_range_relative_attenuation_array(selector_string, relative_attenuation)[source]

Specifies the attenuation, in dB, relative to the external attenuation. Supported devices: PXIe-5665, PXIe-5668

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
relative_attenuation (float) – This parameter specifies an array of attenuation values, in dB, relative to the external attenuation. Use this parameter to compensate for the variations in external attenuation when offset channels are spread wide in frequency. The default value is 0.

Returns:

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

Return type:

int

configure_range_sweep_time(selector_string, sweep_time_auto, sweep_time_interval)[source]

Configures the sweep time. Use “range<n>” as the selector string to configure this method. Supported devices: PXIe-5665, PXIe-5668

Parameters:

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

Example:

”range0”

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

sweep_time_auto (enums.SpurSweepTimeAuto, 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 Spur Range Sweep Time attribute.
True (1)	The measurement calculates the sweep time based on the value of the Spur Range 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

configure_range_sweep_time_array(selector_string, sweep_time_auto, sweep_time_interval)[source]

Configures the sweep time. Supported devices: PXIe-5665, PXIe-5668

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.SpurSweepTimeAuto, 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 Spur Range Sweep Time attribute.
True (1)	The measurement calculates the sweep time based on the value of the Spur Range RBW attribute.

sweep_time_interval (float) – This parameter specifies the array of sweep times, 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

configure_range_vbw_filter(selector_string, vbw_auto, vbw, vbw_to_rbw_ratio)[source]

Configures the video bandwidth (VBW) settings including VBW Auto, VBW, and VBW to RBW ratio for the specified range. Use “range<n>” as the selector string to configure this method.

Parameters:

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

Example:

”range0”

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

vbw_auto (enums.SpurRangeVbwFilterAutoBandwidth, int) –

This parameter specifies whether the VBW is expressed directly or computed based on VBW to RBW ratio. The default value is True.

Name (Value)	Description
False (0)	Specify the video bandwidth in the VBW parameter. The VBW to RBW Ratio parameter is disregarded in this mode.
True (1)	Specify video bandwidth in terms of the VBW to RBW ratio. The value of the video bandwidth is then computed by using the Spur VBW to RBW Ratio attribute and the Spur Range RBW attribute. The value of the VBW parameter is disregarded in this mode.

vbw (float) – This parameter specifies the video bandwidth when you set the VBW Auto parameter to False. This value is expressed in Hz. The default value is 30KHz.
vbw_to_rbw_ratio (float) – This parameter specifies the VBW to RBW Ratio when you set the VBW Auto parameter to True. The default value is 3.

Returns:

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

Return type:

int

configure_range_vbw_filter_array(selector_string, vbw_auto, vbw, vbw_to_rbw_ratio)[source]

Configures an array of the VBW settings, including VBW Auto, VBW, and VBW to RBW ratio for the specified range.

Parameters:

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

vbw_auto (enums.SpurRangeVbwFilterAutoBandwidth, int) –

This parameter specifies whether the VBW is expressed directly or computed based on VBW to RBW ratio. The default value is True.

Name (Value)	Description
False (0)	Specify the video bandwidth in the VBW parameter. The VBW to RBW Ratio parameter is disregarded in this mode.
True (1)	Specify video bandwidth in terms of the VBW to RBW ratio. The value of the video bandwidth is then computed by using the Spur VBW to RBW Ratio attribute and the Spur Range RBW attribute. The value of the VBW parameter is disregarded in this mode.

vbw (float) – This parameter specifies the video bandwidth when you set the VBW Auto parameter to False. This value is expressed in Hz. The default value is 30KHz.
vbw_to_rbw_ratio (float) – This parameter specifies the VBW to RBW Ratio when you set the VBW Auto parameter to True. The default value is 3.

Returns:

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

Return type:

int

configure_trace_range_index(selector_string, trace_range_index)[source]

Specifies the index of the range used to store and retrieve the spurious emission (Spur) trace. Supported devices: PXIe-5665, PXIe-5668

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
trace_range_index (int) – This parameter specifies the index of the range used to store and retrieve Spur traces. This parameter is not used if you set the ALL_TRACES_ENABLED to FALSE. When you set this parameter to -1, the measurement stores and retrieves traces for all enabled ranges. 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

get_all_traces_enabled(selector_string)[source]

Gets whether to enable the traces to be stored and retrieved after performing the spurious emissions (Spur) 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.

Supported devices: PXIe-5665/5668

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 spurious emissions (Spur) 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.SpurAmplitudeCorrectionType):: 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_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.

Supported devices: PXIe-5665/5668

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 spurious emission (Spur) 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.

Supported devices: PXIe-5665/5668

Name (Value)	Description
False (0)	The measurement is performed on a single acquisition.
True (1)	The Spur measurement uses the Spur Averaging Count attribute as the number of acquisitions over which the Spur measurement is averaged.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SpurAveragingEnabled):: Specifies whether to enable averaging for the spurious emission (Spur) 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 spurious emission (Spur) 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.

Supported devices: PXIe-5665/5668

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.SpurAveragingType):: Specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for spurious emission (Spur) 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_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.

Supported devices: PXIe-5665/5668

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 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.SpurFftWindow):: 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_measurement_enabled(selector_string)[source]

Gets whether to enable the spurious emission (Spur) measurement.

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

The default value is FALSE.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (bool):: Specifies whether to enable the spurious emission (Spur) 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_analysis_threads(selector_string)[source]

Gets the maximum number of threads used for parallelism for spurious emission (Spur) 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.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the maximum number of threads used for parallelism for spurious emission (Spur) 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_ranges(selector_string)[source]

Gets the number of ranges.

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.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of ranges.
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_range_absolute_limit_mode(selector_string)[source]

Gets whether the absolute limit threshold is a flat line or a line with a slope.

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

The default value is Couple.

Supported devices: PXIe-5665/5668

Name (Value)	Description
Manual (0)	The line specified by the Spur Range Abs Limit Start and Spur Range Abs Limit Stop attribute values as the two ends is considered as the threshold.
Couple (1)	The two ends of the line are coupled to the value of the Spur Range Abs Limit Start attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SpurAbsoluteLimitMode):: Specifies whether the absolute limit threshold is a flat line or a line with a slope.
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_range_absolute_limit_start(selector_string)[source]

Gets the absolute power limit corresponding to the beginning of the frequency range. This value is expressed in dBm. This power limit is also set as the absolute power limit for the range when you set the RANGE_ABSOLUTE_LIMIT_MODE attribute to Couple.

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

The default value is -10.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the absolute power limit corresponding to the beginning of the frequency range. This value is expressed in dBm. This power limit is also set as the absolute power limit for the range when you set the RANGE_ABSOLUTE_LIMIT_MODE attribute to Couple.
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_range_absolute_limit_stop(selector_string)[source]

Gets the absolute power limit corresponding to the end of the frequency range. This value is expressed in dBm. The measurement ignores this attribute when you set the RANGE_ABSOLUTE_LIMIT_MODE attribute to Couple.

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

The default value is -10.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the absolute power limit corresponding to the end of the frequency range. This value is expressed in dBm. The measurement ignores this attribute when you set the RANGE_ABSOLUTE_LIMIT_MODE attribute to Couple.
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_range_detector_points(selector_string)[source]

Gets the number of range points after the detector is applied.

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

The default value is 1001.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of range points after the detector is applied.
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_range_detector_type(selector_string)[source]

Gets the type of detector to be used.

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

Refer to Spectral Measurements Concepts topic for more information on detector types.

The default value is None.

Name (Value)	Description
None (0)	The detector is disabled.
Sample (1)	The middle sample in the bucket is detected.
Normal (2)	The maximum value of the samples within the bucket is detected if the signal only rises or if the signal only falls. If the signal, within a bucket, both rises and falls, then the maximum and minimum values of the samples are detected in alternate buckets.
Peak (3)	The maximum value of the samples in the bucket is detected.
Negative Peak (4)	The minimum value of the samples in the bucket is detected.
Average RMS (5)	The average RMS of all the samples in the bucket is detected.
Average Voltage (6)	The average voltage of all the samples in the bucket is detected.
Average Log (7)	The average log of all the samples in the bucket is detected.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SpurRangeDetectorType):: Specifies the type of detector to be used.
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_range_enabled(selector_string)[source]

Gets whether to measure the spurious emissions (Spur) in the frequency range.

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

The default value is True.

Supported devices: PXIe-5665/5668

Name (Value)	Description
False (0)	Disables the acquisition of the frequency range.
True (1)	Enables measurement of Spurs in the frequency range.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SpurRangeEnabled):: Specifies whether to measure the spurious emissions (Spur) in the frequency 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_range_number_of_spurs_to_report(selector_string)[source]

Gets the number of spurious emissions (Spur) that the measurement should report in the frequency range.

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

The default value is 10.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of spurious emissions (Spur) that the measurement should report in the frequency 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_range_peak_excursion(selector_string)[source]

Gets the peak excursion value used to find the spurs in the spectrum. This value is expressed in dB. The signal should rise and fall by at least the peak excursion value, above the threshold, to be considered a spur.

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

The default value is 0.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the peak excursion value used to find the spurs in the spectrum. This value is expressed in dB. The signal should rise and fall by at least the peak excursion value, above the threshold, to be considered a spur.
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_range_peak_threshold(selector_string)[source]

Gets the threshold level above which the measurement detects spurs in the range that you specify using the RANGE_START_FREQUENCY and RANGE_STOP_FREQUENCY attributes. This value is expressed in dBm.

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

The default value is -200.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the threshold level above which the measurement detects spurs in the range that you specify using the RANGE_START_FREQUENCY and RANGE_STOP_FREQUENCY attributes. 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_range_rbw_filter_auto_bandwidth(selector_string)[source]

Gets whether the measurement computes the resolution bandwidth (RBW).

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

The default value is True.

Supported devices: PXIe-5665/5668

Name (Value)	Description
False (0)	The measurement uses the RBW that you specify in the Spur Range RBW attribute.
True (1)	The measurement computes the RBW.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SpurRbwAutoBandwidth):: Specifies whether the measurement computes the resolution bandwidth (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_range_rbw_filter_bandwidth(selector_string)[source]

Gets the bandwidth of the resolution bandwidth (RBW) filter used to sweep the acquired signal, when you set the RANGE_RBW_FILTER_AUTO_BANDWIDTH attribute to False.

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

The default value is 10 kHz.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the bandwidth of the resolution bandwidth (RBW) filter used to sweep the acquired signal, when you set the RANGE_RBW_FILTER_AUTO_BANDWIDTH 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_range_rbw_filter_bandwidth_definition(selector_string)[source]

Gets the bandwidth definition which you use to specify the value of the RANGE_RBW_FILTER_BANDWIDTH attribute.

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

The default value is 3dB.

Name (Value)	Description
3dB (0)	Defines the RBW in terms of the 3dB bandwidth of the RBW filter. When you set the Spur Range RBW Filter Type attribute to FFT Based, RBW is the 3dB bandwidth of the window specified by the Spur FFT Window attribute.
Bin Width (2)	Defines the RBW in terms of the spectrum bin width computed using FFT when you set the Spur Range RBW Filter Type attribute to FFT Based.
ENBW (3)	Defines the RBW in terms of the ENBW bandwidth of the RBW filter. When you set the Spur RBW Filter Type attribute to FFT Based, RBW is the ENBW bandwidth of the window specified by the Spur FFT Window attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SpurRbwFilterBandwidthDefinition):: Specifies the bandwidth definition which you use to specify the value of the RANGE_RBW_FILTER_BANDWIDTH attribute.
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_range_rbw_filter_type(selector_string)[source]

Gets the shape of the digital resolution bandwidth (RBW) filter.

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

The default value is Gaussian.

Supported devices: PXIe-5665/5668

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.SpurRbwFilterType):: Specifies the shape of the digital resolution bandwidth (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_range_relative_attenuation(selector_string)[source]

Gets the attenuation relative to the external attenuation specified by the EXTERNAL_ATTENUATION attribute. This value is expressed in dB. Use the Spur Range Rel Attn attribute to compensate for the variations in external attenuation when offset segments are spread wide in frequency.

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

The default value is 0.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the attenuation relative to the external attenuation specified by the EXTERNAL_ATTENUATION attribute. This value is expressed in dB. Use the Spur Range Rel Attn attribute to compensate for the variations in external attenuation when offset segments are spread wide in 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_range_start_frequency(selector_string)[source]

Gets the start of the frequency range for the measurement. This value is expressed in Hz.

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

The default value is 500 MHz.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the start of the frequency range for the measurement. 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_range_stop_frequency(selector_string)[source]

Gets the stop of the frequency range for the measurement. This value is expressed in Hz.

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

The default value is 1.5 GHz.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the stop of the frequency range for the measurement. 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_range_sweep_time_auto(selector_string)[source]

Gets whether the measurement computes the sweep time.

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

The default value is True.

Supported devices: PXIe-5665/5668

Name (Value)	Description
False (0)	The measurement uses the sweep time that you specify in the Spur Range Sweep Time attribute.
True (1)	The measurement calculates the sweep time based on the value of the Spur Range RBW attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SpurSweepTimeAuto):: 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_range_sweep_time_interval(selector_string)[source]

Gets the sweep time when you set the RANGE_SWEEP_TIME_AUTO attribute to False. This value is expressed in seconds.

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

The default value is 0.001.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the sweep time when you set the RANGE_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_range_vbw_filter_auto_bandwidth(selector_string)[source]

Gets whether the video bandwidth (VBW) is expressed directly or computed based on the VBW to RBW ratio.

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

The default value is True.

Name (Value)	Description
False (0)	Specify the video bandwidth in the Spur Range VBW attribute. The Spur VBW to RBW Ratio attribute is disregarded in this mode.
True (1)	Specify video bandwidth in terms of the VBW to RBW ratio. The value of the video bandwidth is then computed by using the Spur Range VBW to RBW Ratio attribute and the Spur Range RBW attribute. The value of the Spur Range VBW attribute is disregarded in this mode.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SpurRangeVbwFilterAutoBandwidth):: Specifies whether the video bandwidth (VBW) is expressed directly or computed based on the VBW to RBW ratio.
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_range_vbw_filter_bandwidth(selector_string)[source]

Gets the video bandwidth (VBW) in Hz when you set the RANGE_VBW_FILTER_AUTO_BANDWIDTH attribute to False.

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

The default value is 30000.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the video bandwidth (VBW) in Hz when you set the RANGE_VBW_FILTER_AUTO_BANDWIDTH 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_range_vbw_filter_vbw_to_rbw_ratio(selector_string)[source]

Gets the VBW to RBW Ratio when you set the RANGE_VBW_FILTER_AUTO_BANDWIDTH attribute to True.

Use “range<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 (float):: Specifies the VBW to RBW Ratio when you set the RANGE_VBW_FILTER_AUTO_BANDWIDTH 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_trace_range_index(selector_string)[source]

Gets the index of the range used to store and retrieve spurious emission (Spur) traces. This attribute is not used if you set the ALL_TRACES_ENABLED to FALSE. When you set this attribute to -1, the measurement stores and retrieves traces for all enabled ranges.

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.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the index of the range used to store and retrieve spurious emission (Spur) traces. This attribute is not used if you set the ALL_TRACES_ENABLED to FALSE. When you set this attribute to -1, the measurement stores and retrieves traces for all enabled ranges.
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 spurious emissions (Spur) 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.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.
value (bool) – Specifies whether to enable the traces to be stored and retrieved after performing the spurious emissions (Spur) 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:

selector_string (string) – Pass an empty string.
value (enums.SpurAmplitudeCorrectionType, int) – 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.

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.

Supported devices: PXIe-5665/5668

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 spurious emission (Spur) 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.

Supported devices: PXIe-5665/5668

Name (Value)	Description
False (0)	The measurement is performed on a single acquisition.
True (1)	The Spur measurement uses the Spur Averaging Count attribute as the number of acquisitions over which the Spur measurement is averaged.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.SpurAveragingEnabled, int) – Specifies whether to enable averaging for the spurious emission (Spur) 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 spurious emission (Spur) 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.

Supported devices: PXIe-5665/5668

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.SpurAveragingType, int) – Specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for spurious emission (Spur) measurement.

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.

Supported devices: PXIe-5665/5668

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 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.SpurFftWindow, 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_measurement_enabled(selector_string, value)[source]

Sets whether to enable the spurious emission (Spur) measurement.

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

The default value is FALSE.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.
value (bool) – Specifies whether to enable the spurious emission (Spur) 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_analysis_threads(selector_string, value)[source]

Sets the maximum number of threads used for parallelism for spurious emission (Spur) 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.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the maximum number of threads used for parallelism for spurious emission (Spur) 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_ranges(selector_string, value)[source]

Sets the number of ranges.

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.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of ranges.

Returns:

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

Return type:

int

set_range_absolute_limit_mode(selector_string, value)[source]

Sets whether the absolute limit threshold is a flat line or a line with a slope.

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

The default value is Couple.

Supported devices: PXIe-5665/5668

Name (Value)	Description
Manual (0)	The line specified by the Spur Range Abs Limit Start and Spur Range Abs Limit Stop attribute values as the two ends is considered as the threshold.
Couple (1)	The two ends of the line are coupled to the value of the Spur Range Abs Limit Start attribute.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.SpurAbsoluteLimitMode, int) – Specifies whether the absolute limit threshold is a flat line or a line with a slope.

Returns:

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

Return type:

int

set_range_absolute_limit_start(selector_string, value)[source]

Sets the absolute power limit corresponding to the beginning of the frequency range. This value is expressed in dBm. This power limit is also set as the absolute power limit for the range when you set the RANGE_ABSOLUTE_LIMIT_MODE attribute to Couple.

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

The default value is -10.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the absolute power limit corresponding to the beginning of the frequency range. This value is expressed in dBm. This power limit is also set as the absolute power limit for the range when you set the RANGE_ABSOLUTE_LIMIT_MODE attribute to Couple.

Returns:

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

Return type:

int

set_range_absolute_limit_stop(selector_string, value)[source]

Sets the absolute power limit corresponding to the end of the frequency range. This value is expressed in dBm. The measurement ignores this attribute when you set the RANGE_ABSOLUTE_LIMIT_MODE attribute to Couple.

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

The default value is -10.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the absolute power limit corresponding to the end of the frequency range. This value is expressed in dBm. The measurement ignores this attribute when you set the RANGE_ABSOLUTE_LIMIT_MODE attribute to Couple.

Returns:

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

Return type:

int

set_range_detector_points(selector_string, value)[source]

Sets the number of range points after the detector is applied.

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

The default value is 1001.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of range points after the detector is applied.

Returns:

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

Return type:

int

set_range_detector_type(selector_string, value)[source]

Sets the type of detector to be used.

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

Refer to Spectral Measurements Concepts topic for more information on detector types.

The default value is None.

Name (Value)	Description
None (0)	The detector is disabled.
Sample (1)	The middle sample in the bucket is detected.
Normal (2)	The maximum value of the samples within the bucket is detected if the signal only rises or if the signal only falls. If the signal, within a bucket, both rises and falls, then the maximum and minimum values of the samples are detected in alternate buckets.
Peak (3)	The maximum value of the samples in the bucket is detected.
Negative Peak (4)	The minimum value of the samples in the bucket is detected.
Average RMS (5)	The average RMS of all the samples in the bucket is detected.
Average Voltage (6)	The average voltage of all the samples in the bucket is detected.
Average Log (7)	The average log of all the samples in the bucket is detected.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.SpurRangeDetectorType, int) – Specifies the type of detector to be used.

Returns:

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

Return type:

int

set_range_enabled(selector_string, value)[source]

Sets whether to measure the spurious emissions (Spur) in the frequency range.

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

The default value is True.

Supported devices: PXIe-5665/5668

Name (Value)	Description
False (0)	Disables the acquisition of the frequency range.
True (1)	Enables measurement of Spurs in the frequency range.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.SpurRangeEnabled, int) – Specifies whether to measure the spurious emissions (Spur) in the frequency range.

Returns:

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

Return type:

int

set_range_number_of_spurs_to_report(selector_string, value)[source]

Sets the number of spurious emissions (Spur) that the measurement should report in the frequency range.

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

The default value is 10.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of spurious emissions (Spur) that the measurement should report in the frequency range.

Returns:

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

Return type:

int

set_range_peak_excursion(selector_string, value)[source]

Sets the peak excursion value used to find the spurs in the spectrum. This value is expressed in dB. The signal should rise and fall by at least the peak excursion value, above the threshold, to be considered a spur.

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

The default value is 0.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the peak excursion value used to find the spurs in the spectrum. This value is expressed in dB. The signal should rise and fall by at least the peak excursion value, above the threshold, to be considered a spur.

Returns:

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

Return type:

int

set_range_peak_threshold(selector_string, value)[source]

Sets the threshold level above which the measurement detects spurs in the range that you specify using the RANGE_START_FREQUENCY and RANGE_STOP_FREQUENCY attributes. This value is expressed in dBm.

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

The default value is -200.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the threshold level above which the measurement detects spurs in the range that you specify using the RANGE_START_FREQUENCY and RANGE_STOP_FREQUENCY attributes. 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_range_rbw_filter_auto_bandwidth(selector_string, value)[source]

Sets whether the measurement computes the resolution bandwidth (RBW).

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

The default value is True.

Supported devices: PXIe-5665/5668

Name (Value)	Description
False (0)	The measurement uses the RBW that you specify in the Spur Range RBW attribute.
True (1)	The measurement computes the RBW.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.SpurRbwAutoBandwidth, int) – Specifies whether the measurement computes the resolution bandwidth (RBW).

Returns:

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

Return type:

int

set_range_rbw_filter_bandwidth(selector_string, value)[source]

Sets the bandwidth of the resolution bandwidth (RBW) filter used to sweep the acquired signal, when you set the RANGE_RBW_FILTER_AUTO_BANDWIDTH attribute to False.

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

The default value is 10 kHz.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the bandwidth of the resolution bandwidth (RBW) filter used to sweep the acquired signal, when you set the RANGE_RBW_FILTER_AUTO_BANDWIDTH 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_range_rbw_filter_bandwidth_definition(selector_string, value)[source]

Sets the bandwidth definition which you use to specify the value of the RANGE_RBW_FILTER_BANDWIDTH attribute.

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

The default value is 3dB.

Name (Value)	Description
3dB (0)	Defines the RBW in terms of the 3dB bandwidth of the RBW filter. When you set the Spur Range RBW Filter Type attribute to FFT Based, RBW is the 3dB bandwidth of the window specified by the Spur FFT Window attribute.
Bin Width (2)	Defines the RBW in terms of the spectrum bin width computed using FFT when you set the Spur Range RBW Filter Type attribute to FFT Based.
ENBW (3)	Defines the RBW in terms of the ENBW bandwidth of the RBW filter. When you set the Spur RBW Filter Type attribute to FFT Based, RBW is the ENBW bandwidth of the window specified by the Spur FFT Window attribute.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.SpurRbwFilterBandwidthDefinition, int) – Specifies the bandwidth definition which you use to specify the value of the RANGE_RBW_FILTER_BANDWIDTH attribute.

Returns:

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

Return type:

int

set_range_rbw_filter_type(selector_string, value)[source]

Sets the shape of the digital resolution bandwidth (RBW) filter.

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

The default value is Gaussian.

Supported devices: PXIe-5665/5668

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.SpurRbwFilterType, int) – Specifies the shape of the digital resolution bandwidth (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_range_relative_attenuation(selector_string, value)[source]

Sets the attenuation relative to the external attenuation specified by the EXTERNAL_ATTENUATION attribute. This value is expressed in dB. Use the Spur Range Rel Attn attribute to compensate for the variations in external attenuation when offset segments are spread wide in frequency.

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

The default value is 0.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the attenuation relative to the external attenuation specified by the EXTERNAL_ATTENUATION attribute. This value is expressed in dB. Use the Spur Range Rel Attn attribute to compensate for the variations in external attenuation when offset segments are spread wide in frequency.

Returns:

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

Return type:

int

set_range_start_frequency(selector_string, value)[source]

Sets the start of the frequency range for the measurement. This value is expressed in Hz.

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

The default value is 500 MHz.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the start of the frequency range for the measurement. 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_range_stop_frequency(selector_string, value)[source]

Sets the stop of the frequency range for the measurement. This value is expressed in Hz.

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

The default value is 1.5 GHz.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the stop of the frequency range for the measurement. 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_range_sweep_time_auto(selector_string, value)[source]

Sets whether the measurement computes the sweep time.

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

The default value is True.

Supported devices: PXIe-5665/5668

Name (Value)	Description
False (0)	The measurement uses the sweep time that you specify in the Spur Range Sweep Time attribute.
True (1)	The measurement calculates the sweep time based on the value of the Spur Range RBW attribute.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.SpurSweepTimeAuto, 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_range_sweep_time_interval(selector_string, value)[source]

Sets the sweep time when you set the RANGE_SWEEP_TIME_AUTO attribute to False. This value is expressed in seconds.

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

The default value is 0.001.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the sweep time when you set the RANGE_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_range_vbw_filter_auto_bandwidth(selector_string, value)[source]

Sets whether the video bandwidth (VBW) is expressed directly or computed based on the VBW to RBW ratio.

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

The default value is True.

Name (Value)	Description
False (0)	Specify the video bandwidth in the Spur Range VBW attribute. The Spur VBW to RBW Ratio attribute is disregarded in this mode.
True (1)	Specify video bandwidth in terms of the VBW to RBW ratio. The value of the video bandwidth is then computed by using the Spur Range VBW to RBW Ratio attribute and the Spur Range RBW attribute. The value of the Spur Range VBW attribute is disregarded in this mode.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.SpurRangeVbwFilterAutoBandwidth, int) – Specifies whether the video bandwidth (VBW) is expressed directly or computed based on the VBW to RBW ratio.

Returns:

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

Return type:

int

set_range_vbw_filter_bandwidth(selector_string, value)[source]

Sets the video bandwidth (VBW) in Hz when you set the RANGE_VBW_FILTER_AUTO_BANDWIDTH attribute to False.

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

The default value is 30000.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the video bandwidth (VBW) in Hz when you set the RANGE_VBW_FILTER_AUTO_BANDWIDTH 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_range_vbw_filter_vbw_to_rbw_ratio(selector_string, value)[source]

Sets the VBW to RBW Ratio when you set the RANGE_VBW_FILTER_AUTO_BANDWIDTH attribute to True.

Use “range<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 (float) – Specifies the VBW to RBW Ratio when you set the RANGE_VBW_FILTER_AUTO_BANDWIDTH 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_trace_range_index(selector_string, value)[source]

Sets the index of the range used to store and retrieve spurious emission (Spur) traces. This attribute is not used if you set the ALL_TRACES_ENABLED to FALSE. When you set this attribute to -1, the measurement stores and retrieves traces for all enabled ranges.

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.

Supported devices: PXIe-5665/5668

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the index of the range used to store and retrieve spurious emission (Spur) traces. This attribute is not used if you set the ALL_TRACES_ENABLED to FALSE. When you set this attribute to -1, the measurement stores and retrieves traces for all enabled ranges.

Returns:

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

Return type:

int