SpectrumConfiguration

Provides methods to configure the Spectrum measurement.

class nirfmxspecan.spectrum_configuration.SpectrumConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the Spectrum measurement.

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

Configures averaging for the spectrum 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.SpectrumAveragingEnabled, 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.SpectrumAveragingType, 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_detector(selector_string, detector_type, detector_points)[source]

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

Parameters:

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

detector_type (enums.SpectrumDetectorType, 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_fft(selector_string, fft_window, fft_padding)[source]

Configures window and FFT to obtain a spectrum for the spectrum 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.SpectrumFftWindow, 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_start_stop(selector_string, start_frequency, stop_frequency)[source]

Configures the start frequency and stop frequency for the spectrum measurement.

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 start frequency, in Hz, for the spectrum measurement. The default value is 995 MHz.
stop_frequency (float) – This parameter specifies the stop frequency, in Hz, for the spectrum measurement. The default value is 1.005 GHz.

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 Spectrum 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.SpectrumMeasurementMethod, int) –

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

Name (Value)

Description

Normal (0)

The Spectrum measurement acquires the spectrum with the same signal analyzer setting across frequency bands.

Sequential FFT (2)

The Spectrum measurement acquires I/Q samples for a duration specified by the Spectrum Sweep Time attribute. These samples are divided into smaller chunks. If the attribute Spectrum RBW Auto is True, the size of each chunk is defined by the Spectrum Sequential FFT Size attribute. If the attribute Spectrum RBW Auto is False, the Spectrum Sequential FFT Size is auto computed based on the configured Spectrum RBW . The overlap between the chunks is defined by the Spectrum FFT Overlap Mode attribute. FFT is computed on each of these chunks. The resultant FFTs are averaged as per the configured averaging type in the attribute Spectrum FFT Overlap Typeto get the spectrum.

Returns:

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

Return type:

int

configure_noise_compensation_enabled(selector_string, noise_compensation_enabled)[source]

Configures compensation of the spectrum for the inherent noise floor of the signal analyzer.

Parameters:

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

noise_compensation_enabled (enums.SpectrumNoiseCompensationEnabled, int) –

This parameter specifies whether to enable compensation of the spectrum for the inherent noise floor of the signal analyzer. The default value is False.

Name (Value)	Description
False (0)	Disables compensation of the spectrum for the noise floor of the signal analyzer.
True (1)	Enables compensation of the spectrum for the noise floor of the signal analyzer. The noise floor of the signal analyzer is measured for the RF path used by the Spectrum measurement and cached for future use. If signal analyzer or measurement parameters change, noise floors are measured again. Supported Devices: PXIe-5663/5665/5668, PXIe-5830/5831/5832

Returns:

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

Return type:

int

configure_power_units(selector_string, spectrum_power_units)[source]

Configures the units for the absolute power.

Parameters:

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

spectrum_power_units (enums.SpectrumPowerUnits, int) –

This parameter specifies the units for the absolute power. The default value is dBm.

Name (Value)	Description
dBm (0)	The absolute powers are reported in dBm.
dBm/Hz (1)	The absolute powers are reported in dBm/Hz.
dBW (2)	The absolute powers are reported in dBW.
dBV (3)	The absolute powers are reported in dBV.
dBmV (4)	The absolute powers are reported in dBmV.
dBuV (5)	The absolute powers are reported in dBuV.
W (6)	The absolute powers are reported in W.
Volts (7)	The absolute powers are reported in volts.
Volts Squared (8)	The absolute powers are reported in volts2.

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 resolution bandwidth (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.SpectrumRbwAutoBandwidth, 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.SpectrumRbwFilterType, 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_span(selector_string, span)[source]

Configures the frequency range, in Hz, around the center frequency, to acquire for the spectrum measurement.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
span (float) – This parameter specifies the frequency range, in Hz, around the center frequency, to acquire for the measurement. 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_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.SpectrumSweepTimeAuto, 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 calculates the sweep time based on the value of the Spectrum 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_vbw_filter(selector_string, vbw_auto, vbw, vbw_to_rbw_ratio)[source]

Configures the VBW settings including VBW Auto, VBW(Hz) and VBW to RBW ratio.

Parameters:

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

vbw_auto (enums.SpectrumVbwFilterAutoBandwidth, int) –

This parameter specifies whether the VBW is expressed directly or computed based on VBW to RBW ratio. This value is expressed in Hz. 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 Spectrum VBW to RBW Ratio attribute and the Spectrum 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 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

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

Gets whether to analyze just the real I or Q component of the acquired IQ data, or analyze the complex IQ data.

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

The default value is IQ.

Name (Value)	Description
IQ (0)	Measurement analyzes the acquired I+jQ data, resulting generally in a spectrum that is not symmetric around 0 Hz. Spectrum trace result contains both positive and negative frequencies. Since the RMS power of the complex envelope is 3.01 dB higher than that of its equivalent real RF signal, the spectrum trace result of the acquired I+jQ data is scaled by -3.01 dB.
I Only (1)	Measurement ignores the Q data from the acquired I+jQ data and analyzes I+j0, resulting in a spectrum that is symmetric around 0 Hz. Spectrum trace result contains positive frequencies only. Spectrum of I+j0 data is scaled by +3.01 dB to account for the power of the negative frequencies that are not returned in the spectrum trace.
Q Only (2)	Measurement ignores the I data from the acquired I+jQ data and analyzes Q+j0, resulting in a spectrum that is symmetric around 0 Hz. Spectrum trace result contains positive frequencies only. Spectrum of Q+j0 data is scaled by +3.01 dB to account for the power of the negative frequencies that are not returned in the spectrum trace.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SpectrumAnalysisInput):: Specifies whether to analyze just the real I or Q component of the acquired IQ data, or analyze the complex IQ data.
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 spectrum 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 spectrum measurement uses the Spectrum Averaging Count attribute as the number of acquisitions over which the spectrum measurement is averaged.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SpectrumAveragingEnabled):: Specifies whether to enable averaging for the spectrum 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 spectrum 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.SpectrumAveragingType):: Specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for spectrum 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_detector_points(selector_string)[source]

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

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

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

Gets the type of detector to be used.

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

The default value is None.

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

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

Gets the samples to overlap between the consecutive chunks as a percentage of the SEQUENTIAL_FFT_SIZE attribute when you set the MEASUREMENT_METHOD attribute to Sequential FFT and the FFT_OVERLAP_MODE attribute to User Defined. This value is expressed as a percentage.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the samples to overlap between the consecutive chunks as a percentage of the SEQUENTIAL_FFT_SIZE attribute when you set the MEASUREMENT_METHOD attribute to Sequential FFT and the FFT_OVERLAP_MODE attribute to User Defined. This value is expressed as a percentage.
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_overlap_mode(selector_string)[source]

Gets the overlap mode when you set the MEASUREMENT_METHOD attribute to Sequential FFT.

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

The default value is Disabled.

Name (Value)	Description
Disabled (0)	Disables the overlap between the chunks.
Automatic (1)	Measurement sets the overlap based on the value you have set for the Spectrum FFT Window attribute. When you set the Spectrum FFT Window attribute to any value other than None, the number of overlapped samples between consecutive chunks is set to 50% of the value of the Spectrum Sequential FFT Size attribute. When you set the Spectrum FFT Window attribute to None, the chunks are not overlapped and the overlap is set to 0%.
User Defined (2)	Measurement uses the overlap that you specify in the Spectrum FFT Overlap (%) attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SpectrumFftOverlapMode):: Specifies the overlap mode when you set the MEASUREMENT_METHOD attribute to Sequential FFT.
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_overlap_type(selector_string)[source]

Gets the overlap type when you set the MEASUREMENT_METHOD attribute to Sequential FFT.

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)	Linear averaging of the FFTs taken over different chunks of data is performed. RMS averaging reduces signal fluctuations but not the noise floor.
Max (3)	The peak power in the spectrum at each frequency bin is retained from one chunk FFT to the next.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SpectrumFftOverlapType):: Specifies the overlap type when you set the MEASUREMENT_METHOD attribute to Sequential FFT.
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 FFT. The FFT size is given by the following formula:

waveform size * padding

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

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 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. Hence, 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.SpectrumFftWindow):: 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 spectrum 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 spectrum 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 for performing the Spectrum 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 Spectrum measurement acquires the spectrum using the same signal analyzer setting across frequency bands.

Sequential FFT (2)

The Spectrum measurement acquires I/Q samples for a duration specified by the Spectrum Sweep Time attribute. These samples are divided into smaller chunks. If the attribute Spectrum RBW Auto is True, The size of each chunk is defined by the Spectrum Sequential FFT Size attribute. If the attribute Spectrum RBW Auto is False, the Spectrum Sequential FFT Size is auto computed based on the configured Spectrum RBW. The overlap between the chunks is defined by the Spectrum FFT Overlap Mode attribute. FFT is computed on each of these chunks. The resultant FFTs are averaged as per the configured averaging type in the attribute Spectrum FFT Overlap Typeto get the spectrum.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SpectrumMeasurementMethod):: Specifies the method for performing the Spectrum 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_mode(selector_string)[source]

Gets whether the measurement calibrates the noise floor of analyzer or performs the spectrum measurement. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

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

Name (Value)	Description
Measure (0)	Spectrum measurement is performed on the acquired signal.
Calibrate Noise Floor (1)	Manual noise calibration of the signal analyzer is performed for the spectrum measurement.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SpectrumMeasurementMode):: Specifies whether the measurement calibrates the noise floor of analyzer or performs the spectrum measurement. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.
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_noise_calibration_averaging_auto(selector_string)[source]

Gets whether RFmx automatically computes the averaging count used for instrument noise calibration.

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)	RFmx uses the averages that you set for the Spectrum Noise Cal Averaging Count attribute.
True (1)	RFmx uses a noise calibration averaging count of 32.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SpectrumNoiseCalibrationAveragingAuto):: Specifies whether RFmx automatically computes the averaging count used for instrument noise calibration.
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_noise_calibration_averaging_count(selector_string)[source]

Gets the averaging count used for noise calibration when you set the NOISE_CALIBRATION_AVERAGING_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 32.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the averaging count used for noise calibration when you set the NOISE_CALIBRATION_AVERAGING_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_noise_calibration_mode(selector_string)[source]

Gets whether the noise calibration and measurement is performed manually by the user or automatically by RFmx. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

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

The default value is Auto.

Name (Value)

Description

Manual (0)

When you set the Spectrum Meas Mode attribute to Calibrate Noise Floor, you can initiate instrument noise calibration for the spectrum measurement manually. When you set the Spectrum Meas Mode attribute to Measure, you can initiate the spectrum measurement manually.

Auto (1)

When you set the Spectrum Noise Comp Enabled attribute to True, RFmx sets the Input Isolation Enabled attribute to Enabled and calibrates the intrument noise in the current state of the instrument. RFmx then resets the Input Isolation Enabled attribute and performs the spectrum measurement, including compensation for noise from the instrument. RFmx skips noise calibration in this mode if valid noise calibration data is already cached. When you set the Spectrum Noise Comp Enabled attribute to False, RFmx does not calibrate instrument noise and performs only the spectrum measurement without compensating for the noise from the instrument.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SpectrumNoiseCalibrationMode):: Specifies whether the noise calibration and measurement is performed manually by the user or automatically by RFmx. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.
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_noise_compensation_enabled(selector_string)[source]

Gets whether RFmx compensates for the instrument noise while performing the measurement when you set the NOISE_CALIBRATION_MODE attribute to Auto, or when you set the Spectrum Noise Cal Mode attribute to Manual and MEASUREMENT_MODE to Measure. Refer to the Noise Compensation Algorithm topic for more information.

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-5663/5665/5668, PXIe-5830/5831/5832

Name (Value)	Description
False (0)	Disables compensation of the spectrum for the noise floor of the signal analyzer.
True (1)	Enables compensation of the spectrum for the noise floor of the signal analyzer. The noise floor of the signal analyzer is measured for the RF path used by the Spectrum measurement and cached for future use. If signal analyzer or measurement parameters change, noise floors are measured again.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SpectrumNoiseCompensationEnabled):: Specifies whether RFmx compensates for the instrument noise while performing the measurement when you set the NOISE_CALIBRATION_MODE attribute to Auto, or when you set the Spectrum Noise Cal Mode attribute to Manual and MEASUREMENT_MODE to Measure. Refer to the Noise Compensation Algorithm topic for more information.
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_noise_compensation_type(selector_string)[source]

Gets the noise compensation type. Refer to the Noise Compensation Algorithm topic for more information.

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 Analyzer and Termination.

Name (Value)	Description
Analyzer and Termination (0)	Compensates for noise from the analyzer and the 50 ohm termination. The measured power values are in excess of the thermal noise floor.
Analyzer Only (1)	Compensates for the analyzer noise only.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SpectrumNoiseCompensationType):: Specifies the noise compensation type. Refer to the Noise Compensation Algorithm topic for more information.
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 spectrum 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 spectrum 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_power_units(selector_string)[source]

Gets the units for the absolute power.

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

Name (Value)	Description
dBm (0)	The absolute powers are reported in dBm.
dBm/Hz (1)	The absolute powers are reported in dBm/Hz.
dBW (2)	The absolute powers are reported in dBW.
dBV (3)	The absolute powers are reported in dBV.
dBmV (4)	The absolute powers are reported in dBmV.
dBuV (5)	The absolute powers are reported in dBuV.
W (6)	The absolute powers are reported in W.
Volts (7)	The absolute powers are reported in volts.
Volts Squared (8)	The absolute powers are reported in volts2.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SpectrumPowerUnits):: Specifies the units for the absolute power.
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 resolution bandwidth (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 Spectrum RBW attribute.
True (1)	The measurement computes the RBW.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SpectrumRbwAutoBandwidth):: 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_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 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 resolution bandwidth (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_bandwidth_definition(selector_string)[source]

Gets the bandwidth definition which you use to specify the value of the RBW_FILTER_BANDWIDTH 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 Spectrum RBW Filter Type attribute to FFT Based, RBW is the 3dB bandwidth of the window specified by the Spectrum FFT Window attribute.
6dB (1)	Defines the RBW in terms of the 6dB bandwidth of the RBW filter. When you set the Spectrum RBW Filter Type attribute to FFT Based, RBW is the 6dB bandwidth of the window specified by the Spectrum FFT Window attribute.
Bin Width (2)	Defines the RBW in terms of the spectrum bin width computed using FFT when you set the Spectrum 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 Spectrum RBW Filter Type attribute to FFT Based, RBW is the ENBW bandwidth of the window specified by the Spectrum FFT Window attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

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

Gets the shape of the digital resolution bandwidth (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)	The RBW filter has a Gaussian response.
Flat (2)	The RBW filter has a flat response.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

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

Gets the FFT size when you set the MEASUREMENT_METHOD attribute to Sequential FFT. If the attribute RBW_FILTER_AUTO_BANDWIDTH is False, FFT Size is auto computed based on the configured RBW_FILTER_BANDWIDTH

The default value is 512.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the FFT size when you set the MEASUREMENT_METHOD attribute to Sequential FFT. If the attribute RBW_FILTER_AUTO_BANDWIDTH is False, FFT Size is auto computed based on the configured RBW_FILTER_BANDWIDTH
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_span(selector_string)[source]

Gets the frequency range around the center frequency, to acquire for the measurement. 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 range around the center frequency, to acquire 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_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 Spectrum Sweep Time attribute.
True (1)	The measurement calculates the sweep time based on the value of the Spectrum RBW attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SpectrumSweepTimeAuto):: 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_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.

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)	Specify the video bandwidth in the Spectrum VBW attribute. The Spectrum 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 Spectrum VBW to RBW Ratio attribute and the Spectrum RBW attribute. The value of the Spectrum VBW attribute is disregarded in this mode.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

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

Gets the video bandwidth (VBW) in Hz when you set the VBW_FILTER_AUTO_BANDWIDTH 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 30000.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

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

Gets the VBW to RBW Ratio when you set the VBW_FILTER_AUTO_BANDWIDTH 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 3.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the VBW to RBW Ratio when you set the 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)

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

Sets whether to analyze just the real I or Q component of the acquired IQ data, or analyze the complex IQ data.

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

The default value is IQ.

Name (Value)	Description
IQ (0)	Measurement analyzes the acquired I+jQ data, resulting generally in a spectrum that is not symmetric around 0 Hz. Spectrum trace result contains both positive and negative frequencies. Since the RMS power of the complex envelope is 3.01 dB higher than that of its equivalent real RF signal, the spectrum trace result of the acquired I+jQ data is scaled by -3.01 dB.
I Only (1)	Measurement ignores the Q data from the acquired I+jQ data and analyzes I+j0, resulting in a spectrum that is symmetric around 0 Hz. Spectrum trace result contains positive frequencies only. Spectrum of I+j0 data is scaled by +3.01 dB to account for the power of the negative frequencies that are not returned in the spectrum trace.
Q Only (2)	Measurement ignores the I data from the acquired I+jQ data and analyzes Q+j0, resulting in a spectrum that is symmetric around 0 Hz. Spectrum trace result contains positive frequencies only. Spectrum of Q+j0 data is scaled by +3.01 dB to account for the power of the negative frequencies that are not returned in the spectrum trace.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.SpectrumAnalysisInput, int) – Specifies whether to analyze just the real I or Q component of the acquired IQ data, or analyze the complex IQ data.

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 spectrum 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 spectrum measurement uses the Spectrum Averaging Count attribute as the number of acquisitions over which the spectrum measurement is averaged.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.SpectrumAveragingEnabled, int) – Specifies whether to enable averaging for the spectrum 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 spectrum 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.SpectrumAveragingType, int) – Specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for spectrum measurement.

Returns:

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

Return type:

int

set_detector_points(selector_string, value)[source]

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

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

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of trace 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_detector_type(selector_string, value)[source]

Sets the type of detector to be used.

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

The default value is None.

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

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

Sets the samples to overlap between the consecutive chunks as a percentage of the SEQUENTIAL_FFT_SIZE attribute when you set the MEASUREMENT_METHOD attribute to Sequential FFT and the FFT_OVERLAP_MODE attribute to User Defined. This value is expressed as a percentage.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the samples to overlap between the consecutive chunks as a percentage of the SEQUENTIAL_FFT_SIZE attribute when you set the MEASUREMENT_METHOD attribute to Sequential FFT and the FFT_OVERLAP_MODE attribute to User Defined. This value is expressed as a percentage.

Returns:

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

Return type:

int

set_fft_overlap_mode(selector_string, value)[source]

Sets the overlap mode when you set the MEASUREMENT_METHOD attribute to Sequential FFT.

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

The default value is Disabled.

Name (Value)	Description
Disabled (0)	Disables the overlap between the chunks.
Automatic (1)	Measurement sets the overlap based on the value you have set for the Spectrum FFT Window attribute. When you set the Spectrum FFT Window attribute to any value other than None, the number of overlapped samples between consecutive chunks is set to 50% of the value of the Spectrum Sequential FFT Size attribute. When you set the Spectrum FFT Window attribute to None, the chunks are not overlapped and the overlap is set to 0%.
User Defined (2)	Measurement uses the overlap that you specify in the Spectrum FFT Overlap (%) attribute.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.SpectrumFftOverlapMode, int) – Specifies the overlap mode when you set the MEASUREMENT_METHOD attribute to Sequential FFT.

Returns:

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

Return type:

int

set_fft_overlap_type(selector_string, value)[source]

Sets the overlap type when you set the MEASUREMENT_METHOD attribute to Sequential FFT.

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)	Linear averaging of the FFTs taken over different chunks of data is performed. RMS averaging reduces signal fluctuations but not the noise floor.
Max (3)	The peak power in the spectrum at each frequency bin is retained from one chunk FFT to the next.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.SpectrumFftOverlapType, int) – Specifies the overlap type when you set the MEASUREMENT_METHOD attribute to Sequential FFT.

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 FFT. The FFT size is given by the following formula:

waveform size * padding

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

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 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. Hence, 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.SpectrumFftWindow, 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 spectrum 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 spectrum 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 for performing the Spectrum 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 Spectrum measurement acquires the spectrum using the same signal analyzer setting across frequency bands.

Sequential FFT (2)

The Spectrum measurement acquires I/Q samples for a duration specified by the Spectrum Sweep Time attribute. These samples are divided into smaller chunks. If the attribute Spectrum RBW Auto is True, The size of each chunk is defined by the Spectrum Sequential FFT Size attribute. If the attribute Spectrum RBW Auto is False, the Spectrum Sequential FFT Size is auto computed based on the configured Spectrum RBW. The overlap between the chunks is defined by the Spectrum FFT Overlap Mode attribute. FFT is computed on each of these chunks. The resultant FFTs are averaged as per the configured averaging type in the attribute Spectrum FFT Overlap Typeto get the spectrum.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.SpectrumMeasurementMethod, int) – Specifies the method for performing the Spectrum 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_mode(selector_string, value)[source]

Sets whether the measurement calibrates the noise floor of analyzer or performs the spectrum measurement. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

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

Name (Value)	Description
Measure (0)	Spectrum measurement is performed on the acquired signal.
Calibrate Noise Floor (1)	Manual noise calibration of the signal analyzer is performed for the spectrum measurement.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.SpectrumMeasurementMode, int) –
Specifies whether the measurement calibrates the noise floor of analyzer or performs the spectrum measurement. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

Returns:

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

Return type:

int

set_noise_calibration_averaging_auto(selector_string, value)[source]

Sets whether RFmx automatically computes the averaging count used for instrument noise calibration.

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)	RFmx uses the averages that you set for the Spectrum Noise Cal Averaging Count attribute.
True (1)	RFmx uses a noise calibration averaging count of 32.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.SpectrumNoiseCalibrationAveragingAuto, int) – Specifies whether RFmx automatically computes the averaging count used for instrument noise calibration.

Returns:

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

Return type:

int

set_noise_calibration_averaging_count(selector_string, value)[source]

Sets the averaging count used for noise calibration when you set the NOISE_CALIBRATION_AVERAGING_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 32.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the averaging count used for noise calibration when you set the NOISE_CALIBRATION_AVERAGING_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_noise_calibration_mode(selector_string, value)[source]

Sets whether the noise calibration and measurement is performed manually by the user or automatically by RFmx. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

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

The default value is Auto.

Name (Value)

Description

Manual (0)

When you set the Spectrum Meas Mode attribute to Calibrate Noise Floor, you can initiate instrument noise calibration for the spectrum measurement manually. When you set the Spectrum Meas Mode attribute to Measure, you can initiate the spectrum measurement manually.

Auto (1)

When you set the Spectrum Noise Comp Enabled attribute to True, RFmx sets the Input Isolation Enabled attribute to Enabled and calibrates the intrument noise in the current state of the instrument. RFmx then resets the Input Isolation Enabled attribute and performs the spectrum measurement, including compensation for noise from the instrument. RFmx skips noise calibration in this mode if valid noise calibration data is already cached. When you set the Spectrum Noise Comp Enabled attribute to False, RFmx does not calibrate instrument noise and performs only the spectrum measurement without compensating for the noise from the instrument.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.SpectrumNoiseCalibrationMode, int) –
Specifies whether the noise calibration and measurement is performed manually by the user or automatically by RFmx. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.

Returns:

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

Return type:

int

set_noise_compensation_enabled(selector_string, value)[source]

Sets whether RFmx compensates for the instrument noise while performing the measurement when you set the NOISE_CALIBRATION_MODE attribute to Auto, or when you set the Spectrum Noise Cal Mode attribute to Manual and MEASUREMENT_MODE to Measure. Refer to the Noise Compensation Algorithm topic for more information.

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-5663/5665/5668, PXIe-5830/5831/5832

Name (Value)	Description
False (0)	Disables compensation of the spectrum for the noise floor of the signal analyzer.
True (1)	Enables compensation of the spectrum for the noise floor of the signal analyzer. The noise floor of the signal analyzer is measured for the RF path used by the Spectrum measurement and cached for future use. If signal analyzer or measurement parameters change, noise floors are measured again.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.SpectrumNoiseCompensationEnabled, int) –
Specifies whether RFmx compensates for the instrument noise while performing the measurement when you set the NOISE_CALIBRATION_MODE attribute to Auto, or when you set the Spectrum Noise Cal Mode attribute to Manual and MEASUREMENT_MODE to Measure. Refer to the Noise Compensation Algorithm topic for more information.

Returns:

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

Return type:

int

set_noise_compensation_type(selector_string, value)[source]

Sets the noise compensation type. Refer to the Noise Compensation Algorithm topic for more information.

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 Analyzer and Termination.

Name (Value)	Description
Analyzer and Termination (0)	Compensates for noise from the analyzer and the 50 ohm termination. The measured power values are in excess of the thermal noise floor.
Analyzer Only (1)	Compensates for the analyzer noise only.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.SpectrumNoiseCompensationType, int) –
Specifies the noise compensation type. Refer to the Noise Compensation Algorithm topic for more information.

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

Returns:

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

Return type:

int

set_power_units(selector_string, value)[source]

Sets the units for the absolute power.

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

Name (Value)	Description
dBm (0)	The absolute powers are reported in dBm.
dBm/Hz (1)	The absolute powers are reported in dBm/Hz.
dBW (2)	The absolute powers are reported in dBW.
dBV (3)	The absolute powers are reported in dBV.
dBmV (4)	The absolute powers are reported in dBmV.
dBuV (5)	The absolute powers are reported in dBuV.
W (6)	The absolute powers are reported in W.
Volts (7)	The absolute powers are reported in volts.
Volts Squared (8)	The absolute powers are reported in volts2.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.SpectrumPowerUnits, int) – Specifies the units for the absolute power.

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 resolution bandwidth (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 Spectrum RBW attribute.
True (1)	The measurement computes the RBW.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.SpectrumRbwAutoBandwidth, 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_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 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 resolution bandwidth (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_bandwidth_definition(selector_string, value)[source]

Sets the bandwidth definition which you use to specify the value of the RBW_FILTER_BANDWIDTH 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 Spectrum RBW Filter Type attribute to FFT Based, RBW is the 3dB bandwidth of the window specified by the Spectrum FFT Window attribute.
6dB (1)	Defines the RBW in terms of the 6dB bandwidth of the RBW filter. When you set the Spectrum RBW Filter Type attribute to FFT Based, RBW is the 6dB bandwidth of the window specified by the Spectrum FFT Window attribute.
Bin Width (2)	Defines the RBW in terms of the spectrum bin width computed using FFT when you set the Spectrum 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 Spectrum RBW Filter Type attribute to FFT Based, RBW is the ENBW bandwidth of the window specified by the Spectrum FFT Window attribute.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.SpectrumRbwFilterBandwidthDefinition, int) – Specifies the bandwidth definition which you use to specify the value of the 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_rbw_filter_type(selector_string, value)[source]

Sets the shape of the digital resolution bandwidth (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)	The RBW filter has a Gaussian response.
Flat (2)	The RBW filter has a flat response.

Parameters:

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

Sets the FFT size when you set the MEASUREMENT_METHOD attribute to Sequential FFT. If the attribute RBW_FILTER_AUTO_BANDWIDTH is False, FFT Size is auto computed based on the configured RBW_FILTER_BANDWIDTH

The default value is 512.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the FFT size when you set the MEASUREMENT_METHOD attribute to Sequential FFT. If the attribute RBW_FILTER_AUTO_BANDWIDTH is False, FFT Size is auto computed based on the configured RBW_FILTER_BANDWIDTH

Returns:

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

Return type:

int

set_span(selector_string, value)[source]

Sets the frequency range around the center frequency, to acquire for the measurement. 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 range around the center frequency, to acquire 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_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 Spectrum Sweep Time attribute.
True (1)	The measurement calculates the sweep time based on the value of the Spectrum RBW attribute.

Parameters:

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

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)	Specify the video bandwidth in the Spectrum VBW attribute. The Spectrum 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 Spectrum VBW to RBW Ratio attribute and the Spectrum RBW attribute. The value of the Spectrum VBW attribute is disregarded in this mode.

Parameters:

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

Sets the video bandwidth (VBW) in Hz when you set the VBW_FILTER_AUTO_BANDWIDTH 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 30000.

Parameters:

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

Sets the VBW to RBW Ratio when you set the VBW_FILTER_AUTO_BANDWIDTH 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 3.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the VBW to RBW Ratio when you set the 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

validate_noise_calibration_data(selector_string)[source]

Indicates whether calibration data is valid for the configuration specified by the signal name in the Selector string parameter.

Parameters:

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

Returns:

noise_calibration_data_valid (enums.SpectrumNoiseCalibrationDataValid):

This parameter returns whether the calibration data is valid.

Name (Value)	Description
False (0)	Returns false if the calibration data is not present for the specified configuration or if the difference between the current device temperature and the calibration temperature exceeds the [-5 °C, 5 °C] range.
True (1)	Returns true if the calibration data is present for the configuration specified by the signal name in the Selector string parameter.

error_code (int):

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

Return type:

Tuple (noise_calibration_data_valid, error_code)