AcpConfiguration

Provides methods to configure the Acp measurement.

class nirfmxspecan.acp_configuration.AcpConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the Acp measurement.

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

Configures averaging for the adjacent channel power (ACP) 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.AcpAveragingEnabled, int) –

This parameter specifies whether to enable averaging of the spectrum 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 Averaging Count parameter to calculate the number of acquisitions over which the spectrum 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.AcpAveragingType, 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_carrier_and_offsets(selector_string, integration_bandwidth, number_of_offsets, channel_spacing)[source]

Configures a carrier channel with offset channels on both sides of the carrier as specified by the number of offsets. The offset channels are separated by +/- n * channel spacing from the center of the carrier. Power is measured over the integration bandwidth for each channel.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
integration_bandwidth (float) – This parameter specifies the frequency range, in Hz, over which the measurement integrates the carrier channel power. The default value is 1 MHz.
number_of_offsets (int) – This parameter specifies the number of offset channels. The default value is 1.
channel_spacing (float) – This parameter specifies the spacing between offset channels. 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_carrier_frequency(selector_string, carrier_frequency)[source]

Configures the center frequency of the carrier, relative to the RF center frequency.

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

Parameters:

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

Example:

”carrier0”

You can use the build_carrier_string() method to build the selector string.
carrier_frequency (float) – This parameter specifies the center frequency, in Hz, of the carrier, relative to the RF CENTER_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_carrier_integration_bandwidth(selector_string, integration_bandwidth)[source]

Configures the frequency range, in Hz, over which the measurement integrates the carrier power. Use “carrier<n>” as the selector string to configure this method.

Parameters:

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

Example:

”carrier0”

You can use the build_carrier_string() method to build the selector string.
integration_bandwidth (float) – This parameter specifies the frequency range, in Hz, over which the measurement integrates the carrier channel power. 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_carrier_mode(selector_string, carrier_mode)[source]

Configures whether to consider the carrier power as part of total carrier power measurement. Use “carrier<n>” as the selector string to configure this method.

Parameters:

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

Example:

”carrier0”

You can use the build_carrier_string() method to build the selector string.
carrier_mode (enums.AcpCarrierMode, int) –
This parameter specifies whether to consider the carrier power as part of total carrier power measurement. The default value is Active.

Name (Value)

Description

Passive (0)

The carrier power is not considered as part of total carrier power.

Active (1)

The carrier power is considered as part of total carrier power.

Returns:

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

Return type:

int

configure_carrier_rrc_filter(selector_string, rrc_filter_enabled, rrc_alpha)[source]

Configures the root-raised-cosine (RRC) filter to apply on the carrier channel before measuring the carrier channel power. Use “carrier<n>” as the selector string to configure this method.

Parameters:

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

Example:

”carrier0”

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

rrc_filter_enabled (enums.AcpCarrierRrcFilterEnabled, int) –

This parameter specifies whether to apply the root-raised-cosine (RRC) filter on the acquired carrier channel before measuring the carrier channel power. The default value is False.

Name (Value)	Description
False (0)	The channel power of the acquired carrier channel is measured directly.
True (1)	The RRC filter on the acquired carrier channel is applied before measuring the carrier channel power.

rrc_alpha (float) – This parameter specifies the roll-off factor for the root-raised-cosine (RRC) filter. The default value is 0.1.

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.AcpDetectorType, 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 adjacent channel power (ACP) 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.AcpFftWindow, 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_measurement_method(selector_string, measurement_method)[source]

Configures the method for performing the adjacent channel power (ACP) 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.AcpMeasurementMethod, int) –

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

Name (Value)	Description
Normal (0)	The ACP measurement acquires the spectrum with the same signal analyzer setting across frequency bands. Use this method when measurement speed is desirable over higher dynamic range.
Dynamic Range (1)	The ACP measurement acquires the spectrum using the hardware-specific optimizations for different frequency bands. Use this method to get the best dynamic range. Supported devices: PXIe-5665/5668
Sequential FFT (2)	The ACP measurement acquires I/Q samples for a duration specified by the ACP Sweep Time attribute. These samples are divided into smaller chunks. The size of each chunk is defined by the ACP Sequential FFT Size attribute. The overlap between the chunks is defined by the ACP FFT Overlap Mode attribute. FFT is computed on each of these chunks. The resultant FFTs are averaged to get the spectrum and is used to compute ACP.

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 channel powers 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.AcpNoiseCompensationEnabled, int) –

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

Name (Value)	Description
False (0)	Disables compensation of the channel powers for the noise floor of the signal analyzer.
True (1)	Enables compensation of the channel powers for the noise floor of the signal analyzer. The noise floor of the signal analyzer is measured for the RF path used by the ACP 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/5842/5860

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

Configures the number of carriers for the adjacent channel power (ACP) measurement.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
number_of_carriers (int) – This parameter specifies the number of carriers. 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_number_of_offsets(selector_string, number_of_offsets)[source]

Configures the number of offsets for the adjacent channel power (ACP) measurement.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
number_of_offsets (int) – This parameter specifies the number of offset channels. 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_offset(selector_string, offset_frequency, offset_sideband, offset_enabled)[source]

Configures an offset channel on one or both sides of carrier with center to center spacing as specified by the offset frequency and offset frequency definition. In case of multiple carriers, offset frequency is relative to the closest carrier.

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

Parameters:

selector_string (string) –
This parameter specifies the Selector String comprising of offset number.

Example:

”offset0”

You can use the build_offset_string() method to build the selector string.
offset_frequency (float) – This parameter specifies the center or edge frequency, in Hz, of the offset channel, relative to the center frequency of the closest carrier as determined by the OFFSET_FREQUENCY_DEFINITION attribute. The sign of offset frequency is ignored and the Offset Sideband parameter determines whether the upper, lower, or both offsets are measured. The default value is 1 MHz.

offset_sideband (enums.AcpOffsetSideband, int) –

This parameter specifies whether the offset segment is present on one side, or on both sides of the carriers. The default value is Both.

Name (Value)	Description
Neg (0)	Configures a lower offset segment to the left of the leftmost carrier.
Pos (1)	Configures an upper offset segment to the right of the rightmost carrier.
Both (2)	Configures both negative and positive offset segments.

offset_enabled (enums.AcpOffsetEnabled, int) –
This parameter specifies whether to enable the offset channel for ACP measurement. The default value is True.

Name (Value)

Description

False (0)

Disables the offset channel for ACP measurement.

True (1)

Enables the offset channel for ACP measurement.

Returns:

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

Return type:

int

configure_offset_array(selector_string, offset_frequency, offset_sideband, offset_enabled)[source]

Configures an offset channel on one or both sides of carrier with center to center spacing as specified by the offset frequency and offset frequency definition. In case of multiple carriers, offset frequency is relative to the closest carrier.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
offset_frequency (float) – This parameter specifies an array of center or edge frequencies, in Hz, of the offset channel, relative to the center frequency of the closest carrier as determined by the OFFSET_FREQUENCY_DEFINITION attribute. The sign of offset frequency is ignored and the Offset Sideband parameter determines whether the upper, lower, or both offsets are measured. The default value is 1 MHz.

offset_sideband (enums.AcpOffsetSideband, int) –

This parameter specifies whether the offset segment is present on one side, or on both sides of the carriers. The default value is Both.

Name (Value)	Description
Neg (0)	Configures a lower offset segment to the left of the leftmost carrier.
Pos (1)	Configures an upper offset segment to the right of the rightmost carrier.
Both (2)	Configures both negative and positive offset segments.

offset_enabled (enums.AcpOffsetEnabled, int) –
This parameter specifies whether to enable the offset channel for ACP measurement. The default value is True.

Name (Value)

Description

False (0)

Disables the offset channel for ACP measurement.

True (1)

Enables the offset channel for ACP measurement.

Returns:

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

Return type:

int

configure_offset_frequency_definition(selector_string, offset_frequency_definition)[source]

Configures the offset frequency definition for the ACP measurement. Use “offset<n>” as the selector string to configure this method.

Parameters:

selector_string (string) –
This parameter specifies the Selector String comprising of offset number.

Example:

”offset0”

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

offset_frequency_definition (enums.AcpOffsetFrequencyDefinition, int) –

This parameter specifies the offset frequency definition. The default value is Carrier Center to Offset Center.

Name (Value)	Description
Carrier Center to Offset Center (0)	The offset frequency is defined from the center of the closest carrier to the center of the offset channel.
Carrier Center to Offset Edge (1)	The offset frequency is defined from the center of the closest carrier to the nearest edge of the offset channel.

Returns:

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

Return type:

int

configure_offset_integration_bandwidth(selector_string, integration_bandwidth)[source]

Configures the frequency range, in Hz, over which the measurement integrates the offset channel power. Use “offset<n>” as the selector string to configure this method.

Parameters:

selector_string (string) –
This parameter specifies the Selector String comprising of offset number.

Example:

”offset0”

You can use the build_offset_string() method to build the selector string.
integration_bandwidth (float) – This parameter specifies the frequency range, in Hz, over which the measurement integrates the offset channel power. 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_offset_integration_bandwidth_array(selector_string, integration_bandwidth)[source]

Configures the frequency range, in Hz, over which the measurement integrates the offset channel power.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
integration_bandwidth (float) – This parameter specifies an array of frequency ranges, in Hz, over which the measurement integrates the offset channel power. 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_offset_power_reference(selector_string, offset_reference_carrier, offset_reference_specific)[source]

Configures the power reference to use for measuring the relative power of the offset channel.

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

Parameters:

selector_string (string) –
This parameter specifies the Selector String comprising of offset number.

Example:

”offset0”

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

offset_reference_carrier (enums.AcpOffsetPowerReferenceCarrier, int) –

This parameter specifies the carrier to be used as power reference to measure offset channel relative power. The offset channel power is measured only if you set the CARRIER_MODE attribute of the reference carrier to Active. The default value is Closest.

Name (Value)	Description
Closest (0)	The measurement uses the power measured in the carrier closest to the offset channel center frequency, as the power reference.
Highest (1)	The measurement uses the highest power measured among all the active carriers as the power reference.
Composite (2)	The measurement uses the sum of powers measured in all the active carriers as the power reference.
Specific (3)	The measurement uses the power measured in the carrier that has an index specified by the ACP Offset Pwr Ref Specific attribute, as the power reference.

offset_reference_specific (int) – This parameter specifies the index of the carrier to be used as the reference carrier. The power measured in this carrier is used as the power reference for measuring the offset channel relative power, when you set the Offset Power Reference Carrier parameter to Specific. 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_offset_power_reference_array(selector_string, offset_power_reference_carrier, offset_power_reference_specific)[source]

Configures the power reference to use for measuring the relative power of the offset channel.

Parameters:

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

offset_power_reference_carrier (enums.AcpOffsetPowerReferenceCarrier, int) –

This parameter specifies the array of carriers to be used as power reference to measure offset channel relative power. The offset channel power is measured only if you set the CARRIER_MODE attribute of the reference carrier to Active. The default value is Closest.

Name (Value)	Description
Closest (0)	The measurement uses the power measured in the carrier closest to the offset channel center frequency, as the power reference.
Highest (1)	The measurement uses the highest power measured among all the active carriers as the power reference.
Composite (2)	The measurement uses the sum of powers measured in all the active carriers as the power reference.
Specific (3)	The measurement uses the power measured in the carrier that has an index specified by the ACP Offset Pwr Ref Specific attribute, as the power reference.

offset_power_reference_specific (int) – This parameter specifies the array of carrier indices to use as the reference carrier for each offset channel. The power measured in this carrier is used as the power reference for measuring the offset channel relative power, when you set the Offset Power Reference Carrier parameter to Specific. 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_offset_relative_attenuation(selector_string, relative_attenuation)[source]

Configures the attenuation, in dB, relative to the external attenuation. Use “offset<n>” as the selector string to configure this method.

Parameters:

selector_string (string) –
This parameter specifies the Selector String comprising of offset number.

Example:

”offset0”

You can use the build_offset_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_offset_relative_attenuation_array(selector_string, relative_attenuation)[source]

Configures the attenuation, in dB, relative to the external attenuation.

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_offset_rrc_filter(selector_string, rrc_filter_enabled, rrc_alpha)[source]

Configures the root raised cosine (RRC) channel filter to be applied on the offset channel before measuring channel power. Use “offset<n>” as the selector string to configure this method.

Parameters:

selector_string (string) –
This parameter specifies the Selector String comprising of offset number.

Example:

”offset0”

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

rrc_filter_enabled (enums.AcpOffsetRrcFilterEnabled, int) –

This parameter specifies whether to apply the root-raised-cosine (RRC) filter on the acquired offset channel before measuring the offset channel power. The default value is False.

Name (Value)	Description
False (0)	The channel power of the acquired offset channel is measured directly.
True (1)	The measurement applies the RRC filter on the acquired offset channel before measuring the offset channel power.

rrc_alpha (float) – This parameter specifies the roll-off factor for the root-raised-cosine (RRC) filter. The default value is 0.1.

Returns:

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

Return type:

int

configure_offset_rrc_filter_array(selector_string, rrc_filter_enabled, rrc_alpha)[source]

Configures the root raised cosine (RRC) channel filter to be applied on the offset channel before measuring channel power.

Parameters:

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

rrc_filter_enabled (enums.AcpOffsetRrcFilterEnabled, int) –

This parameter specifies whether to apply the root-raised-cosine (RRC) filter on the acquired offset channel before measuring the offset channel power. The default value is False.

Name (Value)	Description
False (0)	The channel power of the acquired offset channel is measured directly.
True (1)	The measurement applies the RRC filter on the acquired offset channel before measuring the offset channel power.

rrc_alpha (float) – This parameter specifies an array of roll-off factors of the root-raised-cosine (RRC) filter to apply on the acquired offset channel before measuring the offset channel power. The default value is 0.1.

Returns:

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

Return type:

int

configure_power_units(selector_string, 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.
power_units (enums.AcpPowerUnits, 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.

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.AcpRbwAutoBandwidth, int) –
This parameter specifies whether the measurement computes the RBW. Refer to the RBW and Sweep Time section in the ACP 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.AcpRbwFilterType, int) –
This parameter specifies the response of the digital RBW filter. The default value is Gaussian.

Name (Value)

Description

FFT Based (0)

No RBW filtering is performed.

Gaussian (1)

An RBW filter with a Gaussian response is applied.

Flat (2)

An RBW filter with a flat response is applied.

Returns:

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

Return type:

int

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

Configures the sweep time.

Parameters:

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

sweep_time_auto (enums.AcpSweepTimeAuto, 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 ACP RBW attribute. Refer to the ACP topic for more information about RBW.

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

Returns:

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

Return type:

int

get_all_traces_enabled(selector_string)[source]

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

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

The default value is FALSE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (bool):: Specifies whether to enable the traces to be stored and retrieved after performing the ACP 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.AcpAmplitudeCorrectionType):: 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.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

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

Gets the center frequency of the carrier, relative to the RF CENTER_FREQUENCY. This value is expressed in Hz.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the center frequency of the carrier, relative to the RF CENTER_FREQUENCY. 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_carrier_integration_bandwidth(selector_string)[source]

Gets the frequency range over which the measurement integrates the carrier power. This value is expressed in Hz.

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

The default value is 1 MHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the frequency range over which the measurement integrates the carrier power. 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_carrier_mode(selector_string)[source]

Gets whether to consider the carrier power as part of the total carrier power measurement.

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

The default value is Active.

Name (Value)	Description
Passive (0)	The carrier power is not considered as part of the total carrier power.
Active (1)	The carrier power is considered as part of the total carrier power.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AcpCarrierMode):: Specifies whether to consider the carrier power as part of the total carrier power 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_carrier_rrc_filter_alpha(selector_string)[source]

Gets the roll-off factor for the root-raised-cosine (RRC) filter.

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

The default value is 0.1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the roll-off factor for the root-raised-cosine (RRC) 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_carrier_rrc_filter_enabled(selector_string)[source]

Gets whether to apply the root-raised-cosine (RRC) filter on the acquired carrier channel before measuring the carrier channel power.

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

The default value is False.

Name (Value)	Description
False (0)	The channel power of the acquired carrier channel is measured directly.
True (1)	The measurement applies the RRC filter on the acquired carrier channel before measuring the carrier channel power.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AcpCarrierRrcFilterEnabled):: Specifies whether to apply the root-raised-cosine (RRC) filter on the acquired carrier channel before measuring the carrier channel 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_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.AcpDetectorType):: 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_far_if_output_power_offset(selector_string)[source]

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

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

The default value is 20 dB.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the offset by which to adjust the IF output power level for offset channels that are far from the carrier channel to improve the dynamic range. This value is expressed in dB. This attribute is used only if you set the MEASUREMENT_METHOD attribute to Dynamic Range and set the IF_OUTPUT_POWER_OFFSET_AUTO attribute to False.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_fft_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 ACP FFT Window attribute. When you set the ACP 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 ACP Sequential FFT Size attribute. When you set the ACP 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 ACP FFT Overlap attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

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

Gets the factor by which the time-domain waveform is zero-padded before fast Fourier transform (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 fast Fourier transform (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.AcpFftWindow):: 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_if_output_power_offset_auto(selector_string)[source]

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

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

The default value is True.

Name (Value)	Description
False (0)	The measurement sets the IF output power level offset using the values of the ACP Near IF Output Power Offset and ACP Far IF Output Power Offset attributes.
True (1)	The measurement automatically computes an IF output power level offset for the offset channels to improve the dynamic range of the ACP measurement.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AcpIFOutputPowerOffsetAuto):: Specifies whether the measurement computes an IF output power level offset for the offset channels to improve the dynamic range of the ACP measurement. This attribute is used only if you set the MEASUREMENT_METHOD attribute to Dynamic Range.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_measurement_enabled(selector_string)[source]

Gets whether to enable the ACP 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 ACP 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 ACP 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 ACP measurement acquires the spectrum using the same signal analyzer setting across frequency bands. Use this method when measurement speed is desirable over higher dynamic range.
Dynamic Range (1)	The ACP measurement acquires the spectrum using the hardware-specific optimizations for different frequency bands. Use this method to get the best dynamic range. Supported devices: PXIe-5665/5668
Sequential FFT (2)	The ACP measurement acquires I/Q samples for a duration specified by the ACP Sweep Time attribute. These samples are divided into smaller chunks. The size of each chunk is defined by the ACP Sequential FFT Size attribute. The overlap between the chunks is defined by the ACP FFT Overlap Mode attribute. FFT is computed on each of these chunks. The resultant FFTs are averaged to get the spectrum and is used to compute ACP.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AcpMeasurementMethod):: Specifies the method for performing the ACP 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 ACP 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)	ACP measurement is performed on the acquired signal.
Calibrate Noise Floor (1)	Manual noise calibration of the signal analyzer is performed for the ACP measurement.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AcpMeasurementMode):: Specifies whether the measurement calibrates the noise floor of analyzer or performs the ACP 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_near_if_output_power_offset(selector_string)[source]

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

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

The default value is 10 dB.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the offset by which to adjust the IF output power level for offset channels that are near to the carrier channel to improve the dynamic range. This value is expressed in dB. This attribute is used only if you set the MEASUREMENT_METHOD attribute to Dynamic Range and set the IF_OUTPUT_POWER_OFFSET_AUTO attribute to False.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_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 ACP Noise Cal Averaging Count attribute.

True (1)

When you set the ACP Meas Method attribute to Normal or Sequential FFT, RFmx uses a noise calibration averaging count of 32. When you set the ACP Meas Method attribute to Dynamic Range and the sweep time is less than 5 ms, RFmx uses a noise calibration averaging count of 15. When you set the ACP Meas Method attribute to Dynamic Range and the sweep time is greater than or equal to 5 ms, RFmx uses a noise calibration averaging count of 5.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AcpNoiseCalibrationAveragingAuto):: 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 ACP Meas Mode attribute to Calibrate Noise Floor, you can initiate instrument noise calibration for the ACP measurement manually. When you set the ACP Meas Mode attribute to Measure, you can initiate the ACP measurement manually.

Auto (1)

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AcpNoiseCalibrationMode):: 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 ACP 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.

Name (Value)	Description
False (0)	Disables noise compensation.
True (1)	Enables noise compensation.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AcpNoiseCompensationEnabled):: 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 ACP 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.AcpNoiseCompensationType):: 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 adjacent channel power (ACP) 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 adjacent channel power (ACP) 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_carriers(selector_string)[source]

Gets the number of carriers.

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

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

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

Gets the number of offset channels.

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

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

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

Gets whether to enable the offset channel for ACP measurement.

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

The default value is True.

Name (Value)	Description
False (0)	Disables the offset channel for ACP measurement.
True (1)	Enables the offset channel for ACP measurement.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AcpOffsetEnabled):: Specifies whether to enable the offset channel for ACP 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_offset_frequency(selector_string)[source]

Gets the center or edge frequency of the offset channel, relative to the center frequency of the closest carrier as determined by the OFFSET_FREQUENCY_DEFINITION attribute. This value is expressed in Hz. The sign of offset frequency is ignored and the OFFSET_SIDEBAND attribute determines whether the upper, lower, or both offsets are measured.

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

The default value is 1 MHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the center or edge frequency of the offset channel, relative to the center frequency of the closest carrier as determined by the OFFSET_FREQUENCY_DEFINITION attribute. This value is expressed in Hz. The sign of offset frequency is ignored and the OFFSET_SIDEBAND attribute determines whether the upper, lower, or both offsets are measured.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_offset_frequency_definition(selector_string)[source]

Gets the offset frequency definition used to specify the OFFSET_FREQUENCY attribute.

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

The default value is Carrier Center to Offset Center.

Name (Value)	Description
Carrier Center to Offset Center (0)	The offset frequency is defined from the center of the closest carrier to the center of the offset channel.
Carrier Center to Offset Edge (1)	The offset frequency is defined from the center of the closest carrier to the nearest edge of the offset channel.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AcpOffsetFrequencyDefinition):: Specifies the offset frequency definition used to specify the OFFSET_FREQUENCY 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_offset_integration_bandwidth(selector_string)[source]

Gets the frequency range, over which the measurement integrates the offset channel power. This value is expressed in Hz.

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

The default value is 1 MHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the frequency range, over which the measurement integrates the offset channel power. 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_offset_power_reference_carrier(selector_string)[source]

Gets the carrier to be used as power reference to measure the offset channel relative power. The offset channel power is measured only if you set the CARRIER_MODE attribute of the reference carrier to Active.

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

The default value is Closest.

Name (Value)	Description
Closest (0)	The measurement uses the power measured in the carrier closest to the offset channel center frequency, as the power reference.
Highest (1)	The measurement uses the highest power measured among all the active carriers as the power reference.
Composite (2)	The measurement uses the sum of powers measured in all the active carriers as the power reference.
Specific (3)	The measurement uses the power measured in the carrier that has an index specified by the ACP Offset Pwr Ref Specific attribute, as the power reference.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AcpOffsetPowerReferenceCarrier):: Specifies the carrier to be used as power reference to measure the offset channel relative power. The offset channel power is measured only if you set the CARRIER_MODE attribute of the reference carrier to Active.
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_offset_power_reference_specific(selector_string)[source]

Gets the index of the carrier to be used as the reference carrier. The power measured in this carrier is used as the power reference for measuring the offset channel relative power, when you set the OFFSET_POWER_REFERENCE_CARRIER attribute to Specific.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the index of the carrier to be used as the reference carrier. The power measured in this carrier is used as the power reference for measuring the offset channel relative power, when you set the OFFSET_POWER_REFERENCE_CARRIER attribute to Specific.
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_offset_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 ACP Offset Rel Attn attribute to compensate for variations in external attenuation when the offset channels are spread wide in frequency.

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

The default value is 0.

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 ACP Offset Rel Attn attribute to compensate for variations in external attenuation when the offset channels 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_offset_rrc_filter_alpha(selector_string)[source]

Gets the roll-off factor for the root-raised-cosine (RRC) filter.

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

The default value is 0.1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the roll-off factor for the root-raised-cosine (RRC) 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_offset_rrc_filter_enabled(selector_string)[source]

Gets whether to apply the root-raised-cosine (RRC) filter on the acquired offset channel before measuring the offset channel power.

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

The default value is False.

Name (Value)	Description
False (0)	The channel power of the acquired offset channel is measured directly.
True (1)	The measurement applies the RRC filter on the acquired offset channel before measuring the offset channel power.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AcpOffsetRrcFilterEnabled):: Specifies whether to apply the root-raised-cosine (RRC) filter on the acquired offset channel before measuring the offset channel 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_offset_sideband(selector_string)[source]

Gets whether the offset channel is present on one side, or on both sides of the carrier.

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

The default value is Both.

Name (Value)	Description
Neg (0)	Configures a lower offset segment to the left of the leftmost carrier.
Pos (1)	Configures an upper offset segment to the right of the rightmost carrier.
Both (2)	Configures both negative and positive offset segments.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AcpOffsetSideband):: Specifies whether the offset channel is present on one side, or on both sides of the carrier.
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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AcpPowerUnits):: 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 ACP RBW attribute.
True (1)	The measurement computes the RBW.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

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

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

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AcpRbwFilterBandwidthDefinition):: 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)	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.AcpRbwFilterType):: 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.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

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

set_all_traces_enabled(selector_string, value)[source]

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

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

The default value is FALSE.

Parameters:

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

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

Parameters:

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

Returns:

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

Return type:

int

set_carrier_frequency(selector_string, value)[source]

Sets the center frequency of the carrier, relative to the RF CENTER_FREQUENCY. This value is expressed in Hz.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the center frequency of the carrier, relative to the RF CENTER_FREQUENCY. 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_carrier_integration_bandwidth(selector_string, value)[source]

Sets the frequency range over which the measurement integrates the carrier power. This value is expressed in Hz.

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

The default value is 1 MHz.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the frequency range over which the measurement integrates the carrier power. 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_carrier_mode(selector_string, value)[source]

Sets whether to consider the carrier power as part of the total carrier power measurement.

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

The default value is Active.

Name (Value)	Description
Passive (0)	The carrier power is not considered as part of the total carrier power.
Active (1)	The carrier power is considered as part of the total carrier power.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AcpCarrierMode, int) – Specifies whether to consider the carrier power as part of the total carrier power measurement.

Returns:

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

Return type:

int

set_carrier_rrc_filter_alpha(selector_string, value)[source]

Sets the roll-off factor for the root-raised-cosine (RRC) filter.

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

The default value is 0.1.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the roll-off factor for the root-raised-cosine (RRC) filter.

Returns:

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

Return type:

int

set_carrier_rrc_filter_enabled(selector_string, value)[source]

Sets whether to apply the root-raised-cosine (RRC) filter on the acquired carrier channel before measuring the carrier channel power.

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

The default value is False.

Name (Value)	Description
False (0)	The channel power of the acquired carrier channel is measured directly.
True (1)	The measurement applies the RRC filter on the acquired carrier channel before measuring the carrier channel power.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AcpCarrierRrcFilterEnabled, int) – Specifies whether to apply the root-raised-cosine (RRC) filter on the acquired carrier channel before measuring the carrier channel power.

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

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

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

The default value is 20 dB.

Parameters:

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

Returns:

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

Return type:

int

set_fft_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 ACP FFT Window attribute. When you set the ACP 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 ACP Sequential FFT Size attribute. When you set the ACP 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 ACP FFT Overlap attribute.

Parameters:

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

Sets the factor by which the time-domain waveform is zero-padded before fast Fourier transform (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 fast Fourier transform (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.AcpFftWindow, 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_if_output_power_offset_auto(selector_string, value)[source]

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

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

The default value is True.

Name (Value)	Description
False (0)	The measurement sets the IF output power level offset using the values of the ACP Near IF Output Power Offset and ACP Far IF Output Power Offset attributes.
True (1)	The measurement automatically computes an IF output power level offset for the offset channels to improve the dynamic range of the ACP measurement.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AcpIFOutputPowerOffsetAuto, int) – Specifies whether the measurement computes an IF output power level offset for the offset channels to improve the dynamic range of the ACP measurement. This attribute is used only if you set the MEASUREMENT_METHOD attribute to Dynamic Range.

Returns:

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

Return type:

int

set_measurement_enabled(selector_string, value)[source]

Sets whether to enable the ACP 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 ACP 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 ACP 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 ACP measurement acquires the spectrum using the same signal analyzer setting across frequency bands. Use this method when measurement speed is desirable over higher dynamic range.
Dynamic Range (1)	The ACP measurement acquires the spectrum using the hardware-specific optimizations for different frequency bands. Use this method to get the best dynamic range. Supported devices: PXIe-5665/5668
Sequential FFT (2)	The ACP measurement acquires I/Q samples for a duration specified by the ACP Sweep Time attribute. These samples are divided into smaller chunks. The size of each chunk is defined by the ACP Sequential FFT Size attribute. The overlap between the chunks is defined by the ACP FFT Overlap Mode attribute. FFT is computed on each of these chunks. The resultant FFTs are averaged to get the spectrum and is used to compute ACP.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AcpMeasurementMethod, int) – Specifies the method for performing the ACP 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 ACP 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)	ACP measurement is performed on the acquired signal.
Calibrate Noise Floor (1)	Manual noise calibration of the signal analyzer is performed for the ACP measurement.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AcpMeasurementMode, int) –
Specifies whether the measurement calibrates the noise floor of analyzer or performs the ACP 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_near_if_output_power_offset(selector_string, value)[source]

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

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

The default value is 10 dB.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the offset by which to adjust the IF output power level for offset channels that are near to the carrier channel to improve the dynamic range. This value is expressed in dB. This attribute is used only if you set the MEASUREMENT_METHOD attribute to Dynamic Range and set the IF_OUTPUT_POWER_OFFSET_AUTO attribute to False.

Returns:

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

Return type:

int

set_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 ACP Noise Cal Averaging Count attribute.

True (1)

When you set the ACP Meas Method attribute to Normal or Sequential FFT, RFmx uses a noise calibration averaging count of 32. When you set the ACP Meas Method attribute to Dynamic Range and the sweep time is less than 5 ms, RFmx uses a noise calibration averaging count of 15. When you set the ACP Meas Method attribute to Dynamic Range and the sweep time is greater than or equal to 5 ms, RFmx uses a noise calibration averaging count of 5.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AcpNoiseCalibrationAveragingAuto, 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 ACP Meas Mode attribute to Calibrate Noise Floor, you can initiate instrument noise calibration for the ACP measurement manually. When you set the ACP Meas Mode attribute to Measure, you can initiate the ACP measurement manually.

Auto (1)

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

Parameters:

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

Name (Value)	Description
False (0)	Disables noise compensation.
True (1)	Enables noise compensation.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AcpNoiseCompensationEnabled, 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 ACP 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.AcpNoiseCompensationType, 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 adjacent channel power (ACP) 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 adjacent channel power (ACP) 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_carriers(selector_string, value)[source]

Sets the number of carriers.

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

The default value is 1.

Parameters:

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

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

Sets the number of offset channels.

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

The default value is 1.

Parameters:

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

Returns:

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

Return type:

int

set_offset_enabled(selector_string, value)[source]

Sets whether to enable the offset channel for ACP measurement.

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

The default value is True.

Name (Value)	Description
False (0)	Disables the offset channel for ACP measurement.
True (1)	Enables the offset channel for ACP measurement.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AcpOffsetEnabled, int) – Specifies whether to enable the offset channel for ACP measurement.

Returns:

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

Return type:

int

set_offset_frequency(selector_string, value)[source]

Sets the center or edge frequency of the offset channel, relative to the center frequency of the closest carrier as determined by the OFFSET_FREQUENCY_DEFINITION attribute. This value is expressed in Hz. The sign of offset frequency is ignored and the OFFSET_SIDEBAND attribute determines whether the upper, lower, or both offsets are measured.

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

The default value is 1 MHz.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the center or edge frequency of the offset channel, relative to the center frequency of the closest carrier as determined by the OFFSET_FREQUENCY_DEFINITION attribute. This value is expressed in Hz. The sign of offset frequency is ignored and the OFFSET_SIDEBAND attribute determines whether the upper, lower, or both offsets are measured.

Returns:

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

Return type:

int

set_offset_frequency_definition(selector_string, value)[source]

Sets the offset frequency definition used to specify the OFFSET_FREQUENCY attribute.

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

The default value is Carrier Center to Offset Center.

Name (Value)	Description
Carrier Center to Offset Center (0)	The offset frequency is defined from the center of the closest carrier to the center of the offset channel.
Carrier Center to Offset Edge (1)	The offset frequency is defined from the center of the closest carrier to the nearest edge of the offset channel.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AcpOffsetFrequencyDefinition, int) – Specifies the offset frequency definition used to specify the OFFSET_FREQUENCY attribute.

Returns:

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

Return type:

int

set_offset_integration_bandwidth(selector_string, value)[source]

Sets the frequency range, over which the measurement integrates the offset channel power. This value is expressed in Hz.

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

The default value is 1 MHz.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the frequency range, over which the measurement integrates the offset channel power. 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_offset_power_reference_carrier(selector_string, value)[source]

Sets the carrier to be used as power reference to measure the offset channel relative power. The offset channel power is measured only if you set the CARRIER_MODE attribute of the reference carrier to Active.

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

The default value is Closest.

Name (Value)	Description
Closest (0)	The measurement uses the power measured in the carrier closest to the offset channel center frequency, as the power reference.
Highest (1)	The measurement uses the highest power measured among all the active carriers as the power reference.
Composite (2)	The measurement uses the sum of powers measured in all the active carriers as the power reference.
Specific (3)	The measurement uses the power measured in the carrier that has an index specified by the ACP Offset Pwr Ref Specific attribute, as the power reference.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AcpOffsetPowerReferenceCarrier, int) – Specifies the carrier to be used as power reference to measure the offset channel relative power. The offset channel power is measured only if you set the CARRIER_MODE attribute of the reference carrier to Active.

Returns:

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

Return type:

int

set_offset_power_reference_specific(selector_string, value)[source]

Sets the index of the carrier to be used as the reference carrier. The power measured in this carrier is used as the power reference for measuring the offset channel relative power, when you set the OFFSET_POWER_REFERENCE_CARRIER attribute to Specific.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the index of the carrier to be used as the reference carrier. The power measured in this carrier is used as the power reference for measuring the offset channel relative power, when you set the OFFSET_POWER_REFERENCE_CARRIER attribute to Specific.

Returns:

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

Return type:

int

set_offset_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 ACP Offset Rel Attn attribute to compensate for variations in external attenuation when the offset channels are spread wide in frequency.

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

The default value is 0.

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 ACP Offset Rel Attn attribute to compensate for variations in external attenuation when the offset channels 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_offset_rrc_filter_alpha(selector_string, value)[source]

Sets the roll-off factor for the root-raised-cosine (RRC) filter.

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

The default value is 0.1.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the roll-off factor for the root-raised-cosine (RRC) filter.

Returns:

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

Return type:

int

set_offset_rrc_filter_enabled(selector_string, value)[source]

Sets whether to apply the root-raised-cosine (RRC) filter on the acquired offset channel before measuring the offset channel power.

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

The default value is False.

Name (Value)	Description
False (0)	The channel power of the acquired offset channel is measured directly.
True (1)	The measurement applies the RRC filter on the acquired offset channel before measuring the offset channel power.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AcpOffsetRrcFilterEnabled, int) – Specifies whether to apply the root-raised-cosine (RRC) filter on the acquired offset channel before measuring the offset channel power.

Returns:

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

Return type:

int

set_offset_sideband(selector_string, value)[source]

Sets whether the offset channel is present on one side, or on both sides of the carrier.

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

The default value is Both.

Name (Value)	Description
Neg (0)	Configures a lower offset segment to the left of the leftmost carrier.
Pos (1)	Configures an upper offset segment to the right of the rightmost carrier.
Both (2)	Configures both negative and positive offset segments.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AcpOffsetSideband, int) – Specifies whether the offset channel is present on one side, or on both sides of the carrier.

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.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AcpPowerUnits, 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 ACP RBW attribute.
True (1)	The measurement computes the RBW.

Parameters:

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

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

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

Parameters:

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

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.

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

Parameters:

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

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.AcpNoiseCalibrationDataValid):

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)