AcpConfiguration

Provides methods to configure the Acp measurement.

class nirfmxlte.acp_configuration.AcpConfiguration(signal_obj)

Bases: object

Provides methods to configure the Acp measurement.

configure_averaging(selector_string, averaging_enabled, averaging_count, averaging_type)

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 measurement is averaged over multiple acquisitions. The number of acquisitions is obtained by the Averaging Count parameter.

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

Returns:

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

Return type:

int

configure_configurable_number_of_offsets_enabled(selector_string, configurable_number_of_offsets_enabled)

Configures whether the number of offsets will be computed by the measurement or configured by the user.

Parameters:

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

• configurable_number_of_offsets_enabled (enums.AcpConfigurableNumberOfOffsetsEnabled, int) –

  This parameter specifies whether the number of offsets is computed by measurement or configured by you. When the carrier bandwidth is 200 kHz or the LINK_DIRECTION is Downlink, the default value is False. The default value is True, otherwise.

  Note

  Incase of downlink, this attribute is applicable only for number of EUTRA offsets. For the number of UTRA offsets, only 3GPP specification defined values are supported.

  Name (Value)	Description
  False (0)	Measurement will set the number of offsets.
  True (1)	Measurement will use the user configured value for number of offsets.

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)

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/5668
  Sequential FFT (2)	The ACP measurement acquires I/Q samples specified by the ACP Sweep Time attribute. These samples are divided into smaller chunks defined by the ACP Sequential FFT Size attribute, and FFT is computed on each of these chunks. The resultant FFTs are averaged to get the spectrum and is used to compute 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.

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)

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 remeasured. 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_eutra_offsets(selector_string, number_of_eutra_offsets)

Configures the number of evolved universal terrestrial radio access adjacent channels of the subblock, when you set the ACP_CONFIGURABLE_NUMBER_OF_OFFSETS_ENABLED attribute to True.

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

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of the subblock number. The default is “” (empty string).

  Example:

  ”subblock0”

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

• number_of_eutra_offsets (int) –

  This parameter specifies the number of E-UTRA adjacent channel offsets to be configured at offset positions, when you set the ACP Configurable Number of Offset Enabled attribute to True.

  In case of non-contiguous carrier aggregation, the configured value will be used only for the outer offsets and the offset channels in the gap region are defined as per the 3GPP specification. Offset integration bandwidth and offset power reference for the outer E-UTRA offsets are set according to the value of ACP_EUTRA_OFFSET_DEFINITION attribute.

  The default value is 0, when carrier bandwidth is 200 kHz. The default value is 2 for downlink and 1 for uplink, otherwise.

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_gsm_offsets(selector_string, number_of_gsm_offsets)

Configures the number of GSM adjacent channels of the subblock, when you set the ACP_CONFIGURABLE_NUMBER_OF_OFFSETS_ENABLED attribute to True.

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

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of the subblock number. The default is “” (empty string).

  Example:

  ”subblock0”

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

• number_of_gsm_offsets (int) –

  This parameter specifies the number of GSM adjacent channel offsets to be configured when you set the COMPONENT_CARRIER_BANDWIDTH to 200.0 k and when you set the ACP Configurable Number of Offset Enabled attribute to True.

  The frequency offset from the center of NB-IOT carrier to the center of the first offset is 300 kHz as defined in the 3GPP specification. The center of every other offset is placed at 200 kHz from the previous offset’s center.

  The default value is 1, when you set the CC Bandwidth attribute to is 200.0 k. The default value is 0, otherwise.

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_utra_offsets(selector_string, number_of_utra_offsets)

Configures the number of universal terrestrial radio access (UTRA) adjacent channels of the subblock, when you set the ACP_CONFIGURABLE_NUMBER_OF_OFFSETS_ENABLED attribute to True.

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

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of the subblock number. The default is “” (empty string).

  Example:

  ”subblock0”

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

• number_of_utra_offsets (int) –

  This parameter specifies the number of UTRA adjacent channel offsets to be configured at offset positions, when you set the ACP Configurable Number of Offset Enabled attribute to True.

  In case of downlink, only 3GPP specification defined values are supported. In case of non-contiguous carrier aggregation, the configured value will be used only for the outer offsets and the offset channels in the gap region are defined as per the 3GPP specification. Offset power reference for the outer UTRA offsets are set according to the value of ACP_EUTRA_OFFSET_DEFINITION attribute.

  The default value is 1, when carrier bandwidth is 200 kHz.

  The default value is 0, when the band is 46 or when you set the ACP_EUTRA_OFFSET_DEFINITION attribute to LAA.

  The default value is 2 for all other configurations.

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)

Configures the units for 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 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)

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

• rbw_filter_type (enums.AcpRbwFilterType, int) –

  This parameter specifies the shape of the digital RBW filter. The default value is FFT Based.

  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)

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 uses a sweep time of 1 ms.

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

Returns:

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

Return type:

int

configure_utra_and_eutra_offsets(selector_string, number_of_utra_offsets, number_of_eutra_offsets)

Configures the number of universal terrestrial radio access (UTRA) and evolved universal terrestrial radio access (E-UTRA) adjacent channels of the subblock. This method is valid only for uplink single carrier, and contiguous carrier aggregation. In case of uplink non-contiguous multi-carrier and downlink, the number of UTRA/EUTRA offsets are determined from the 3GPP specification.

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

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of the subblock number. The default is “” (empty string).

  Example:

  ”subblock0”

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

• number_of_utra_offsets (int) – This parameter specifies the number of UTRA adjacent channel offsets to be configured at offset positions as defined in the 3GPP specification. The default value is 2.

• number_of_eutra_offsets (int) – This parameter specifies the number of E-UTRA adjacent channel offsets to be configured at offset positions as defined in the 3GPP specification. The default value is 1.

Returns:

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

Return type:

int

get_all_traces_enabled(selector_string)

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)

Gets whether the amplitude of the frequency bins, used in measurements, 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 measurements, 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)

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)

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)

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.

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_component_carrier_integration_bandwidth(selector_string)

Gets the integration bandwidth of the component carrier (CC). This value is expressed in Hz.

Use “carrier<k>” or “subblock<n>/carrier<k>” as the selector string to read this result.

The default value is 9 MHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the integration bandwidth of the component carrier (CC). 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_configurable_number_of_offsets_enabled(selector_string)

Gets whether the number of offsets is computed by measurement or configured by you.

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.

When the carrier bandwidth is 200 kHz or the LINK_DIRECTION is Downlink, the default value is False. The default value is True, otherwise.

Note

In case of downlink, this attribute is valid only for number of E-UTRA offsets. For the number of UTRA offsets, only 3GPP specification defined values are supported.

Name (Value)	Description
False (0)	Measurement will set the number of offsets.
True (1)	Measurement will use the user configured value for number of offsets.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AcpConfigurableNumberOfOffsetsEnabled):

Specifies whether the number of offsets is computed by measurement or configured by you.

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_eutra_offset_definition(selector_string)

Gets the evolved universal terrestrial radio access (E-UTRA) offset channel definition.

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.

Note

In case of non-contiguous, the inner offset channel definition will be configured internally as per the 3GPP specification. Offset power reference for the outer UTRA offsets are set according to ACP EUTRA Offset Definition attribute.

The default value is Auto.

Name (Value)	Description
Auto (0)	Measurement will set the E-UTRA definition and offset power reference based on the link direction. For downlink, the definition is Closest and for uplink, it is Composite.
Closest (1)	Integration bandwidth is derived from the closest LTE carrier. Offset power reference is set to Closest internally.
Composite (2)	Integration bandwidth is derived from the aggregated sub-block bandwidth. Offset power reference is set as Composite Sub-Block.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AcpEutraOffsetDefinition):

Specifies the evolved universal terrestrial radio access (E-UTRA) offset channel definition.

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)

Gets the offset that is needed to adjust the IF output power levels for the offset channels that are far from the carrier channel to improve the dynamic range. This value is expressed in dB. This attribute is valid only when you set the ACP_IF_OUTPUT_POWER_OFFSET_AUTO attribute to False and 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 20.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the offset that is needed to adjust the IF output power levels for the offset channels that are far from the carrier channel to improve the dynamic range. This value is expressed in dB. This attribute is valid only when you set the ACP_IF_OUTPUT_POWER_OFFSET_AUTO attribute to False and 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_fft_overlap(selector_string)

Gets the samples to overlap between the consecutive chunks as a percentage of the ACP_SEQUENTIAL_FFT_SIZE attribute value when you set the ACP_MEASUREMENT_METHOD attribute to Sequential FFT and the ACP_FFT_OVERLAP_MODE attribute to User Defined.

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 ACP_SEQUENTIAL_FFT_SIZE attribute value when you set the ACP_MEASUREMENT_METHOD attribute to Sequential FFT and the ACP_FFT_OVERLAP_MODE attribute to User Defined.

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)

Gets the overlap mode when you set the ACP_MEASUREMENT_METHOD attribute to Sequential FFT. In Sequential FFT method, the measurement divides all the acquired samples into smaller FFT chunks of equal size. Then the FFT is computed for each chunk. The resultant FFTs are averaged to get the spectrum used to compute the ACP.

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 FFT chunks.
Automatic (1)	Measurement sets the number of overlapped samples between consecutive FFT chunks to 50% of the ACP Sequential FFT Size attribute value.
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 ACP_MEASUREMENT_METHOD attribute to Sequential FFT. In Sequential FFT method, the measurement divides all the acquired samples into smaller FFT chunks of equal size. Then the FFT is computed for each chunk. The resultant FFTs are averaged to get the spectrum used to compute the ACP.

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)

Gets whether the measurement computes an appropriate IF output power level offset for the offset channels to improve the dynamic range of the ACP measurement. This attribute is valid only when 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 sets the IF output power level offset using the values of the ACP Near IF Output Pwr Offset and ACP Far IF Output Pwr 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 appropriate IF output power level offset for the offset channels to improve the dynamic range of the ACP measurement. This attribute is valid only when 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_measurement_enabled(selector_string)

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)

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 all the samples specified by the ACP Sweep Time attribute and divides them in to smaller chunks of equal size defined by the ACP Sequential FFT Size attribute. FFT is computed for each chunk. 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.

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)

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)

Gets the offset that is needed to adjust the IF output power levels for the offset channels that are near the carrier channel to improve the dynamic range. This value is expressed in dB. This attribute is valid only when you set the ACP_IF_OUTPUT_POWER_OFFSET_AUTO attribute to False and 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 10.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the offset that is needed to adjust the IF output power levels for the offset channels that are near the carrier channel to improve the dynamic range. This value is expressed in dB. This attribute is valid only when you set the ACP_IF_OUTPUT_POWER_OFFSET_AUTO attribute to False and 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_noise_calibration_averaging_auto(selector_string)

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 ACP Noise Cal Averaging Count attribute.
True (1)	RFmx uses the following averaging counts:

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)

Gets the averaging count used for noise calibration when you set the ACP_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 ACP_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)

Gets whether the noise calibration and measurement is performed automatically by the measurement or by you. 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 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 attribute 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 Input Isolation Enabled attribute and performs the ACP measurement including compensation for the noise contribution of the instrument. RFmx skips noise calibration in this mode if valid noise calibration data is already cached.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AcpNoiseCalibrationMode):

Specifies whether the noise calibration and measurement is performed automatically by the measurement or by you. 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)

Gets whether RFmx compensates for the instrument noise while performing the measurement when you set the ACP_NOISE_CALIBRATION_MODE attribute to Auto, or when you set the ACP Noise Cal Mode attribute to Manual and the ACP_MEASUREMENT_MODE attribute to Measure. 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 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 the measurement parameters change, noise floors are remeasured. Supported Devices: PXIe-5663/5665/5668, PXIe-5830/5831/5832/5842/5860

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 ACP_NOISE_CALIBRATION_MODE attribute to Auto, or when you set the ACP Noise Cal Mode attribute to Manual and the ACP_MEASUREMENT_MODE attribute to Measure. 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_type(selector_string)

Gets the noise compensation type. 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 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 analyzer noise only.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AcpNoiseCompensationType):

Specifies the noise compensation type. 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_number_of_analysis_threads(selector_string)

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_eutra_offsets(selector_string)

Gets the number of evolved universal terrestrial radio access (E-UTRA) adjacent channel offsets to be configured at offset positions, when you set the ACP_CONFIGURABLE_NUMBER_OF_OFFSETS_ENABLED attribute to True.

Use “subblock<n>” as the selector string to configure or read this attribute.

The default value is 0, when carrier bandwidth is 200 kHz. The default value is 2 for downlink and 1 for uplink, otherwise.

Note

In case of non-contiguous carrier aggregation, the configured value will be used only for the outer offsets and the offset channels in the gap region are defined as per the 3GPP specification. Offset integration bandwidth and offset power reference for the outer E-UTRA offsets are set according to the value of ACP_EUTRA_OFFSET_DEFINITION attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of evolved universal terrestrial radio access (E-UTRA) adjacent channel offsets to be configured at offset positions, when you set the ACP_CONFIGURABLE_NUMBER_OF_OFFSETS_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_number_of_gsm_offsets(selector_string)

Gets the number of GSM adjacent channel offsets to be configured when you set the COMPONENT_CARRIER_BANDWIDTH to 200.0 k and the ACP_CONFIGURABLE_NUMBER_OF_OFFSETS_ENABLED attribute to True.

The frequency offset from the center of NB-IOT carrier to the center of the first offset is 300 kHz as defined in the 3GPP specification. The center of every other offset is placed at 200 kHz from the previous offset’s center.

Use “subblock<n>” as the selector string to configure or read this attribute.

The default value is 1, when you set the CC Bandwidth attribute to is 200.0 k and Link Direction to Uplink. The default value is 0, otherwise.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of GSM adjacent channel offsets to be configured when you set the COMPONENT_CARRIER_BANDWIDTH to 200.0 k and the ACP_CONFIGURABLE_NUMBER_OF_OFFSETS_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_number_of_standalone_nb_iot_offsets(selector_string)

Gets the number of Standalone NB-IoT adjacent channel offsets to be configured when you set the COMPONENT_CARRIER_BANDWIDTH to 200.0 k, LINK_DIRECTION to Downlink and the ACP_CONFIGURABLE_NUMBER_OF_OFFSETS_ENABLED attribute to True.

The frequency offset from the center of NB-IOT carrier to the center of the first offset is 300 kHz as defined in the 3GPP specification. The center of every other offset is placed at 200 kHz from the previous offset’s center.

Use “subblock<n>” as the selector string to configure or read this attribute.

The default value is 2, when you set the CC Bandwidth attribute to is 200.0 k and the Link Direction to is Downlink. The default value is 0, otherwise.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of Standalone NB-IoT adjacent channel offsets to be configured when you set the COMPONENT_CARRIER_BANDWIDTH to 200.0 k, LINK_DIRECTION to Downlink and the ACP_CONFIGURABLE_NUMBER_OF_OFFSETS_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_number_of_utra_offsets(selector_string)

Gets the number of universal terrestrial radio access (UTRA) adjacent channel offsets to be configured at offset positions, when you set the ACP_CONFIGURABLE_NUMBER_OF_OFFSETS_ENABLED attribute to True.

Use “subblock<n>” as the selector string to configure or read this attribute.

The default value is 1, when you set the COMPONENT_CARRIER_BANDWIDTH to 200.0 k and LINK_DIRECTION to Uplink.

The default value is 0, when you set the COMPONENT_CARRIER_BANDWIDTH to 200.0 k and LINK_DIRECTION to Downlink.

The default value is 0, when you set the BAND attribute to 46 or ACP_EUTRA_OFFSET_DEFINITION attribute to LAA.

The default value is 2 for all other configurations.

Note

In case of downlink, only 3GPP specification defined values are supported. In case of non-contiguous carrier aggregation, the configured value will be used only for the outer offsets and the offset channels in the gap region are defined as per the 3GPP specification. Offset power reference for the outer UTRA offsets are set according to the value of ACP_EUTRA_OFFSET_DEFINITION attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of universal terrestrial radio access (UTRA) adjacent channel offsets to be configured at offset positions, when you set the ACP_CONFIGURABLE_NUMBER_OF_OFFSETS_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_offset_frequency(selector_string)

Gets the offset frequency of an offset channel. This value is expressed in Hz. When you set the LINK_DIRECTION attribute to Uplink, the offset frequency is computed from the center of a reference component carrier/subblock to the center of the nearest RBW filter of the offset channel. When you set the Link Direction attribute to Downlink, the offset frequency is computed from the center of the closest component carrier to the center of the nearest RBW filter of the offset channel.

Use “offset<k>” or “subblock<n>/offset<k>” as the selector string to read this result.

The default value is 10 MHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the offset frequency of an offset channel. This value is expressed in Hz. When you set the LINK_DIRECTION attribute to Uplink, the offset frequency is computed from the center of a reference component carrier/subblock to the center of the nearest RBW filter of the offset channel. When you set the Link Direction attribute to Downlink, the offset frequency is computed from the center of the closest component carrier to the center of the nearest RBW filter of the offset channel.

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)

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

Use “offset<k>” or “subblock<n>/offset<k>” as the selector string to read this result.

The default value is 9 MHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the integration bandwidth of an offset carrier. 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_power_units(selector_string)

Gets the units for 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 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)

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)

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

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)

Gets the shape of the 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 FFT Based.

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 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)

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_subblock_integration_bandwidth(selector_string)

Gets the integration bandwidth of the subblock. This value is expressed in Hz. Integration bandwidth is the span from the left edge of the leftmost carrier to the right edge of the rightmost carrier within the subblock.

Use “subblock<n>” as the selector string to read this result.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the integration bandwidth of the subblock. This value is expressed in Hz. Integration bandwidth is the span from the left edge of the leftmost carrier to the right edge of the rightmost carrier within the subblock.

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)

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 a sweep time of 1 ms.

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)

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 1 ms.

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_all_traces_enabled(selector_string, value)

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)

Sets whether the amplitude of the frequency bins, used in measurements, 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 measurements, 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)

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)

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)

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.

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_configurable_number_of_offsets_enabled(selector_string, value)

Sets whether the number of offsets is computed by measurement or configured by you.

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.

When the carrier bandwidth is 200 kHz or the LINK_DIRECTION is Downlink, the default value is False. The default value is True, otherwise.

Note

In case of downlink, this attribute is valid only for number of E-UTRA offsets. For the number of UTRA offsets, only 3GPP specification defined values are supported.

Name (Value)	Description
False (0)	Measurement will set the number of offsets.
True (1)	Measurement will use the user configured value for number of offsets.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.AcpConfigurableNumberOfOffsetsEnabled, int) – Specifies whether the number of offsets is computed by measurement or configured by you.

Returns:

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

Return type:

int

set_eutra_offset_definition(selector_string, value)

Sets the evolved universal terrestrial radio access (E-UTRA) offset channel definition.

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.

Note

In case of non-contiguous, the inner offset channel definition will be configured internally as per the 3GPP specification. Offset power reference for the outer UTRA offsets are set according to ACP EUTRA Offset Definition attribute.

The default value is Auto.

Name (Value)	Description
Auto (0)	Measurement will set the E-UTRA definition and offset power reference based on the link direction. For downlink, the definition is Closest and for uplink, it is Composite.
Closest (1)	Integration bandwidth is derived from the closest LTE carrier. Offset power reference is set to Closest internally.
Composite (2)	Integration bandwidth is derived from the aggregated sub-block bandwidth. Offset power reference is set as Composite Sub-Block.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.AcpEutraOffsetDefinition, int) – Specifies the evolved universal terrestrial radio access (E-UTRA) offset channel definition.

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)

Sets the offset that is needed to adjust the IF output power levels for the offset channels that are far from the carrier channel to improve the dynamic range. This value is expressed in dB. This attribute is valid only when you set the ACP_IF_OUTPUT_POWER_OFFSET_AUTO attribute to False and 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 20.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the offset that is needed to adjust the IF output power levels for the offset channels that are far from the carrier channel to improve the dynamic range. This value is expressed in dB. This attribute is valid only when you set the ACP_IF_OUTPUT_POWER_OFFSET_AUTO attribute to False and 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_fft_overlap(selector_string, value)

Sets the samples to overlap between the consecutive chunks as a percentage of the ACP_SEQUENTIAL_FFT_SIZE attribute value when you set the ACP_MEASUREMENT_METHOD attribute to Sequential FFT and the ACP_FFT_OVERLAP_MODE attribute to User Defined.

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 ACP_SEQUENTIAL_FFT_SIZE attribute value when you set the ACP_MEASUREMENT_METHOD attribute to Sequential FFT and the ACP_FFT_OVERLAP_MODE attribute to User Defined.

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)

Sets the overlap mode when you set the ACP_MEASUREMENT_METHOD attribute to Sequential FFT. In Sequential FFT method, the measurement divides all the acquired samples into smaller FFT chunks of equal size. Then the FFT is computed for each chunk. The resultant FFTs are averaged to get the spectrum used to compute the ACP.

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 FFT chunks.
Automatic (1)	Measurement sets the number of overlapped samples between consecutive FFT chunks to 50% of the ACP Sequential FFT Size attribute value.
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 ACP_MEASUREMENT_METHOD attribute to Sequential FFT. In Sequential FFT method, the measurement divides all the acquired samples into smaller FFT chunks of equal size. Then the FFT is computed for each chunk. The resultant FFTs are averaged to get the spectrum used to compute the ACP.

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)

Sets whether the measurement computes an appropriate IF output power level offset for the offset channels to improve the dynamic range of the ACP measurement. This attribute is valid only when 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 sets the IF output power level offset using the values of the ACP Near IF Output Pwr Offset and ACP Far IF Output Pwr 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 appropriate IF output power level offset for the offset channels to improve the dynamic range of the ACP measurement. This attribute is valid only when 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_measurement_enabled(selector_string, value)

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)

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 all the samples specified by the ACP Sweep Time attribute and divides them in to smaller chunks of equal size defined by the ACP Sequential FFT Size attribute. FFT is computed for each chunk. 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.

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)

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)

Sets the offset that is needed to adjust the IF output power levels for the offset channels that are near the carrier channel to improve the dynamic range. This value is expressed in dB. This attribute is valid only when you set the ACP_IF_OUTPUT_POWER_OFFSET_AUTO attribute to False and 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 10.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the offset that is needed to adjust the IF output power levels for the offset channels that are near the carrier channel to improve the dynamic range. This value is expressed in dB. This attribute is valid only when you set the ACP_IF_OUTPUT_POWER_OFFSET_AUTO attribute to False and 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_noise_calibration_averaging_auto(selector_string, value)

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 ACP Noise Cal Averaging Count attribute.
True (1)	RFmx uses the following averaging counts:

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)

Sets the averaging count used for noise calibration when you set the ACP_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 ACP_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)

Sets whether the noise calibration and measurement is performed automatically by the measurement or by you. 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 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 attribute 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 Input Isolation Enabled attribute and performs the ACP measurement including compensation for the noise contribution of the instrument. RFmx skips noise calibration in this mode if valid noise calibration data is already cached.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.AcpNoiseCalibrationMode, int) –

  Specifies whether the noise calibration and measurement is performed automatically by the measurement or by you. 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)

Sets whether RFmx compensates for the instrument noise while performing the measurement when you set the ACP_NOISE_CALIBRATION_MODE attribute to Auto, or when you set the ACP Noise Cal Mode attribute to Manual and the ACP_MEASUREMENT_MODE attribute to Measure. 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 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 the measurement parameters change, noise floors are remeasured. Supported Devices: PXIe-5663/5665/5668, PXIe-5830/5831/5832/5842/5860

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 ACP_NOISE_CALIBRATION_MODE attribute to Auto, or when you set the ACP Noise Cal Mode attribute to Manual and the ACP_MEASUREMENT_MODE attribute to Measure. 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_type(selector_string, value)

Sets the noise compensation type. 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 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 analyzer noise only.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.AcpNoiseCompensationType, int) –

  Specifies the noise compensation type. 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_number_of_analysis_threads(selector_string, value)

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_eutra_offsets(selector_string, value)

Sets the number of evolved universal terrestrial radio access (E-UTRA) adjacent channel offsets to be configured at offset positions, when you set the ACP_CONFIGURABLE_NUMBER_OF_OFFSETS_ENABLED attribute to True.

Use “subblock<n>” as the selector string to configure or read this attribute.

The default value is 0, when carrier bandwidth is 200 kHz. The default value is 2 for downlink and 1 for uplink, otherwise.

Note

In case of non-contiguous carrier aggregation, the configured value will be used only for the outer offsets and the offset channels in the gap region are defined as per the 3GPP specification. Offset integration bandwidth and offset power reference for the outer E-UTRA offsets are set according to the value of ACP_EUTRA_OFFSET_DEFINITION attribute.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the number of evolved universal terrestrial radio access (E-UTRA) adjacent channel offsets to be configured at offset positions, when you set the ACP_CONFIGURABLE_NUMBER_OF_OFFSETS_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_number_of_gsm_offsets(selector_string, value)

Sets the number of GSM adjacent channel offsets to be configured when you set the COMPONENT_CARRIER_BANDWIDTH to 200.0 k and the ACP_CONFIGURABLE_NUMBER_OF_OFFSETS_ENABLED attribute to True.

The frequency offset from the center of NB-IOT carrier to the center of the first offset is 300 kHz as defined in the 3GPP specification. The center of every other offset is placed at 200 kHz from the previous offset’s center.

Use “subblock<n>” as the selector string to configure or read this attribute.

The default value is 1, when you set the CC Bandwidth attribute to is 200.0 k and Link Direction to Uplink. The default value is 0, otherwise.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the number of GSM adjacent channel offsets to be configured when you set the COMPONENT_CARRIER_BANDWIDTH to 200.0 k and the ACP_CONFIGURABLE_NUMBER_OF_OFFSETS_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_number_of_standalone_nb_iot_offsets(selector_string, value)

Sets the number of Standalone NB-IoT adjacent channel offsets to be configured when you set the COMPONENT_CARRIER_BANDWIDTH to 200.0 k, LINK_DIRECTION to Downlink and the ACP_CONFIGURABLE_NUMBER_OF_OFFSETS_ENABLED attribute to True.

The frequency offset from the center of NB-IOT carrier to the center of the first offset is 300 kHz as defined in the 3GPP specification. The center of every other offset is placed at 200 kHz from the previous offset’s center.

Use “subblock<n>” as the selector string to configure or read this attribute.

The default value is 2, when you set the CC Bandwidth attribute to is 200.0 k and the Link Direction to is Downlink. The default value is 0, otherwise.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the number of Standalone NB-IoT adjacent channel offsets to be configured when you set the COMPONENT_CARRIER_BANDWIDTH to 200.0 k, LINK_DIRECTION to Downlink and the ACP_CONFIGURABLE_NUMBER_OF_OFFSETS_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_number_of_utra_offsets(selector_string, value)

Sets the number of universal terrestrial radio access (UTRA) adjacent channel offsets to be configured at offset positions, when you set the ACP_CONFIGURABLE_NUMBER_OF_OFFSETS_ENABLED attribute to True.

Use “subblock<n>” as the selector string to configure or read this attribute.

The default value is 1, when you set the COMPONENT_CARRIER_BANDWIDTH to 200.0 k and LINK_DIRECTION to Uplink.

The default value is 0, when you set the COMPONENT_CARRIER_BANDWIDTH to 200.0 k and LINK_DIRECTION to Downlink.

The default value is 0, when you set the BAND attribute to 46 or ACP_EUTRA_OFFSET_DEFINITION attribute to LAA.

The default value is 2 for all other configurations.

Note

In case of downlink, only 3GPP specification defined values are supported. In case of non-contiguous carrier aggregation, the configured value will be used only for the outer offsets and the offset channels in the gap region are defined as per the 3GPP specification. Offset power reference for the outer UTRA offsets are set according to the value of ACP_EUTRA_OFFSET_DEFINITION attribute.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the number of universal terrestrial radio access (UTRA) adjacent channel offsets to be configured at offset positions, when you set the ACP_CONFIGURABLE_NUMBER_OF_OFFSETS_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_power_units(selector_string, value)

Sets the units for 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 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)

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)

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

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)

Sets the shape of the 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 FFT Based.

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 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)

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)

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 a sweep time of 1 ms.

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)

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 1 ms.

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

validate_noise_calibration_data(selector_string)

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)