AcpConfiguration

Provides methods to configure the Acp measurement.

class nirfmxcdma2k.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 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 for the measurement. 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 Averaging Count parameter to calculate the number of acquisitions over which the ACP measurement is averaged.

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

averaging_type (enums.AcpAveragingType, int) –

This parameter specifies the averaging type for averaging multiple spectrum acquisitions. RFmx uses the averaged spectrum for the measurement.

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.

Refer to the Averaging section of the Spectrum topic for more information about averaging types.

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 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 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/5668R.
Sequential FFT (2)	The ACP measurement acquires I/Q the samples specified by the ACP Sweep Time. These samples are divided into smaller chunks. The size of each chunk is defined by the ACP Sequential FFT Size attribute, and FFT is computed for each these chunks. The resultant FFTs are averaged to get the spectrum used to compute the the ACP. If the total acquired samples is not an integer multiple of the FFT size, the remaining samples at the end of the acquisition are not used. Use this method to optimize the ACP Measurement speed. The accuracy of results may be reduced when using this measurement method.

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 channel power compensation 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 the signal analyzer or measurement parameters change, noise floors are measured again. Supported Devices: PXIe-5663/5665/5668R, 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_offsets(selector_string, number_of_offsets)[source]

Configures the number of offsets for the 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 2.

Returns:

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

Return type:

int

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

Configures the RBW filter.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
rbw_auto (enums.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 information about RBW and sweep time.

Name (value)

Description

False (0)

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

True (1)

The measurement computes the RBW.

The default value is True.
rbw (float) – This parameter specifies the bandwidth of the RBW filter used to sweep the acquired signal if 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 shape of the digital RBW filter. The default value is Gaussian.

Name (value)

Description

FFT Based (0)

No RBW filtering is performed.

Gaussian (1)

An RBW filter with a Gaussian response is applied.

Flat (2)

An RBW filter with a flat response is applied.

Returns:

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

Return type:

int

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

Name (value)	Description
False (0)	The measurement uses the sweep time that you specify using the Sweep Time Interval parameter.
True (1)	The measurement uses the default sweep time of 0.001667 seconds.

sweep_time_interval (float) – This parameter specifies the sweep time if you set the Sweep Time Auto parameter 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

get_advanced_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 ACP_MEASUREMENT_METHOD attribute to Dynamic Range and set the ACP_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 ACP_MEASUREMENT_METHOD attribute to Dynamic Range and set the ACP_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_advanced_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 ACP_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 does not compute an IF output power level offset for the offset channels.
True (1)	The measurement computes an IF output power level offset for the offset channels.

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 ACP_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_advanced_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 the carrier channel to improve the dynamic range. This value is expressed in dB. This attribute is used only if you set the ACP_MEASUREMENT_METHOD attribute to Dynamic Range and set the ACP_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 the carrier channel to improve the dynamic range. This value is expressed in dB. This attribute is used only if you set the ACP_MEASUREMENT_METHOD attribute to Dynamic Range and set the ACP_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_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_averaging_count(selector_string)[source]

Gets the number of acquisitions used for averaging when you set the ACP_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 ACP_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 value of 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 lowest 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_integration_bandwidth(selector_string)[source]

Gets the ACP carrier integration bandwidth. This value is expressed in Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Returns the ACP carrier integration bandwidth. 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_fft_overlap(selector_string)[source]

Gets the number of samples to overlap between consecutive chunks while performing FFT.

This value is expressed as a percentage of ACP_SEQUENTIAL_FFT_SIZE attribute when you set the ACP_MEASUREMENT_METHOD attribute to Sequential FFT.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Returns the number of samples to overlap between consecutive chunks while performing FFT.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_fft_overlap_mode(selector_string)[source]

Gets how the FFT overlap is applied to the acquired samples.

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

The default Value is Disabled.

Name (Value)	Description
Disabled (0)	Indicates that no overlapping is applied to the acquired samples.
Automatic (1)	Indicates that RFmx chooses optimal values of the ACP FFT Overlap (%) attribute based on the measurement configuration.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AcpFftOverlapMode):: Specifies how the FFT overlap is applied to the acquired samples.
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/5668R.
Sequential FFT (2)	The ACP measurement acquires I/Q the samples specified by the ACP Sweep Time. These samples are divided into smaller chunks. The size of each chunk is defined by the ACP Sequential FFT Size attribute, and FFT is computed for each these chunks. The resultant FFTs are averaged to get the spectrum used to compute the ACP. If the total acquired samples is not an integer multiple of the FFT size, the remaining samples at the end of the acquisition are not used. Use this method to optimize the ACP Measurement speed. The accuracy of results may be reduced when using this measurement method.

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

Gets whether to enable compensation of the channel powers for the inherent noise floor of the signal analyzer.

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 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/5668R, PXIe-5830/5831/5832/5842/5860

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AcpNoiseCompensationEnabled):: Specifies whether to enable compensation of the channel powers for the inherent noise floor of the signal analyzer.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_number_of_analysis_threads(selector_string)[source]

Gets the maximum number of threads used for parallelism for the 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 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_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 2.

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

Gets the frequency of an ACP offset channel relative to the carrier frequency. This value is expressed in Hz.

Use “offset< <format type=”monospace-italic”>n</format> >” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Returns the frequency of an ACP offset channel relative to the carrier 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_offset_integration_bandwidth(selector_string)[source]

Gets the integration bandwidth of an ACP offset channel. This value is expressed in Hz.

Use “offset< <format type=”monospace-italic”>n</format> >” as the Selector String to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Returns the integration bandwidth of an ACP offset channel. 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_auto_bandwidth(selector_string)[source]

Gets whether the measurement computes the RBW.

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

The default value is True.

Name (Value)	Description
False (0)	The measurement uses the RBW that you specify in the 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 RBW.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_rbw_filter_bandwidth(selector_string)[source]

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

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

The default value is 10 kHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the bandwidth of the RBW filter used to sweep the acquired signal when you set the ACP_RBW_FILTER_AUTO_BANDWIDTH attribute to False. This value is expressed in Hz.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_rbw_filter_type(selector_string)[source]

Gets the shape of the digital RBW filter.

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

The default value is Gaussian.

Name (Value)	Description
FFT Based (0)	An RBW filter with an FFT-based response is applied.
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 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 ACP_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 512.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the FFT size, when you set the ACP_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 uses the default sweep time of 0.001667 seconds.

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 ACP_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.0016667 seconds.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the sweep time when you set the ACP_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_advanced_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 ACP_MEASUREMENT_METHOD attribute to Dynamic Range and set the ACP_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 ACP_MEASUREMENT_METHOD attribute to Dynamic Range and set the ACP_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_advanced_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 ACP_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 does not compute an IF output power level offset for the offset channels.
True (1)	The measurement computes an IF output power level offset for the offset channels.

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 ACP_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_advanced_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 the carrier channel to improve the dynamic range. This value is expressed in dB. This attribute is used only if you set the ACP_MEASUREMENT_METHOD attribute to Dynamic Range and set the ACP_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 the carrier channel to improve the dynamic range. This value is expressed in dB. This attribute is used only if you set the ACP_MEASUREMENT_METHOD attribute to Dynamic Range and set the ACP_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_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_averaging_count(selector_string, value)[source]

Sets the number of acquisitions used for averaging when you set the ACP_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 ACP_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 value of 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 lowest 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_fft_overlap_mode(selector_string, value)[source]

Sets how the FFT overlap is applied to the acquired samples.

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

The default Value is Disabled.

Name (Value)	Description
Disabled (0)	Indicates that no overlapping is applied to the acquired samples.
Automatic (1)	Indicates that RFmx chooses optimal values of the ACP FFT Overlap (%) attribute based on the measurement configuration.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AcpFftOverlapMode, int) – Specifies how the FFT overlap is applied to the acquired samples.

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/5668R.
Sequential FFT (2)	The ACP measurement acquires I/Q the samples specified by the ACP Sweep Time. These samples are divided into smaller chunks. The size of each chunk is defined by the ACP Sequential FFT Size attribute, and FFT is computed for each these chunks. The resultant FFTs are averaged to get the spectrum used to compute the ACP. If the total acquired samples is not an integer multiple of the FFT size, the remaining samples at the end of the acquisition are not used. Use this method to optimize the ACP Measurement speed. The accuracy of results may be reduced when using this measurement method.

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

Sets whether to enable compensation of the channel powers for the inherent noise floor of the signal analyzer.

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 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/5668R, PXIe-5830/5831/5832/5842/5860

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AcpNoiseCompensationEnabled, int) – Specifies whether to enable compensation of the channel powers for the inherent noise floor of the signal analyzer.

Returns:

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

Return type:

int

set_number_of_analysis_threads(selector_string, value)[source]

Sets the maximum number of threads used for parallelism for the 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 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_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 2.

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

Sets whether the measurement computes the RBW.

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

The default value is True.

Name (Value)	Description
False (0)	The measurement uses the RBW that you specify in the 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 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 RBW filter used to sweep the acquired signal when you set the ACP_RBW_FILTER_AUTO_BANDWIDTH attribute to False. This value is expressed in Hz.

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

The default value is 10 kHz.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the bandwidth of the RBW filter used to sweep the acquired signal when you set the ACP_RBW_FILTER_AUTO_BANDWIDTH attribute to False. This value is expressed in Hz.

Returns:

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

Return type:

int

set_rbw_filter_type(selector_string, value)[source]

Sets the shape of the digital RBW filter.

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

The default value is Gaussian.

Name (Value)	Description
FFT Based (0)	An RBW filter with an FFT-based response is applied.
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 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 ACP_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 512.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the FFT size, when you set the ACP_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 uses the default sweep time of 0.001667 seconds.

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 ACP_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.0016667 seconds.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the sweep time when you set the ACP_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