AmpmConfiguration

Provides methods to configure the Ampm measurement.

class nirfmxspecan.ampm_configuration.AmpmConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the Ampm measurement.

configure_am_to_am_curve_fit(selector_string, am_to_am_curve_fit_order, am_to_am_curve_fit_type)[source]

Configures the degree of the polynomial and the cost-function for approximating the measured AM-to-AM response of the device under test.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
am_to_am_curve_fit_order (int) – This parameter specifies the degree of the polynomial used to approximate the AM-to-AM characteristic of the device under test. The default value is 7.

am_to_am_curve_fit_type (enums.AmpmAMToAMCurveFitType, int) –

This parameter specifies the polynomial approximation cost-function of the device under test AM-to-AM characteristic. The default value is Least Absolute Residual.

Name (Value)	Description
Least Square (0)	Minimizes the energy of the polynomial approximation error.
Least Absolute Residual (1)	Minimizes the magnitude of the polynomial approximation error.
Bisquare (2)	Excludes the effect of data outliers while minimizing the energy of the polynomial approximation error.

Returns:

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

Return type:

int

configure_am_to_pm_curve_fit(selector_string, am_to_pm_curve_fit_order, am_to_pm_curve_fit_type)[source]

Configures the degree of the polynomial and the cost-function, for approximating the measured AM-to-PM response of the device under test.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
am_to_pm_curve_fit_order (int) – This parameter specifies the degree of the polynomial used to approximate the AM-to-PM characteristic of the device under test. The default value is 7.

am_to_pm_curve_fit_type (enums.AmpmAMToPMCurveFitType, int) –

This parameter specifies the polynomial approximation cost-function of the device under test AM-to-PM characteristic. The default value is Least Absolute Residual.

Name (Value)	Description
Least Square (0)	Minimizes the energy of the polynomial approximation error.
Least Absolute Residual (1)	Minimizes the magnitude of the polynomial approximation error.
Bisquare (2)	Excludes the effect of data outliers while minimizing the energy of the polynomial approximation error.

Returns:

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

Return type:

int

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

Configures averaging for the AMPM 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.AmpmAveragingEnabled, int) –

This parameter specifies whether to enable averaging for the measurement. The default value is False.

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

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

Returns:

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

Return type:

int

configure_compression_points(selector_string, compression_point_enabled, compression_level)[source]

Configures the compression point computation.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
compression_point_enabled (enums.AmpmCompressionPointEnabled, int) – This parameter enables computation of compression points corresponding to the compression levels specified by the Compression Level parameter.
compression_level (float) – This parameter specifies the compression levels for which the compression points are computed when the Compression Point Enabled parameter is set to True. This value is expressed in dB.

Returns:

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

Return type:

int

configure_dut_average_input_power(selector_string, dut_average_input_power)[source]

Configures the average power, in dBm, of the signal at the input port of the device under test.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
dut_average_input_power (float) – This parameter specifies the average power, in dBm, of the signal at the input port of the device under test. The default value is -20 dBm.

Returns:

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

Return type:

int

configure_measurement_interval(selector_string, measurement_interval)[source]

Configures the acquisition time, in seconds, for the AMPM measurement.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
measurement_interval (float) – This parameter specifies the duration, in seconds, of the reference waveform considered for the measurement. When the reference waveform contains an idle duration, the measurement neglects the idle samples in the reference waveform leading up to the start of the first active portion of the reference waveform. The default value is 100E-6.

Returns:

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

Return type:

int

configure_measurement_sample_rate(selector_string, sample_rate_mode, sample_rate)[source]

Configures the acquisition sample rate, in Samples per second (S/s), for the AMPM measurement.

Parameters:

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

sample_rate_mode (enums.AmpmMeasurementSampleRateMode, int) –

This parameter specifies whether the acquisition sample rate is based on the reference waveform. The default value is Reference Waveform.

Name (Value)	Description
User (0)	The acquisition sample rate is defined by the value of the Sample Rate parameter.
Reference Waveform (1)	The acquisition sample rate is set to match the sample rate of the reference waveform.

sample_rate (float) – This parameter specifies the acquisition sample rate, in S/s, when you set the Sample Rate Mode parameter to User. The default value is 120 MHz.

Returns:

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

Return type:

int

configure_reference_power_type(selector_string, reference_power_type)[source]

Configures the reference power to be used for AM to AM and AM to PM traces.

Parameters:

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

reference_power_type (enums.AmpmReferencePowerType, int) –

This parameter specifies the reference power used for AM to AM and AM to PM traces. The default value is Input.

Name (Value)	Description
Input (0)	The instantaneous powers at the input port of the device under test (DUT) forms the x-axis of AM to AM and AM to PM traces.
Output (1)	The instantaneous powers at the output port of the DUT forms the x-axis of AM to AM and AM to PM traces.

Returns:

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

Return type:

int

configure_reference_waveform(selector_string, x0, dx, reference_waveform, idle_duration_present, signal_type)[source]

Configures the reference waveform and its attributes for the AMPM measurement.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
x0 (float) – This parameter specifies the start time, in seconds.
dx (float) – This parameter specifies the sample duration, in seconds.
reference_waveform (numpy.complex64) – This parameter specifies the complex baseband samples, in volts.
idle_duration_present (enums.AmpmReferenceWaveformIdleDurationPresent, int) –
This parameter specifies whether the reference waveform contains an idle duration. The default value is False.

Name (Value)

Description

False (0)

The reference waveform does not contain an idle duration.

True (1)

The reference waveform contains an idle duration.

signal_type (enums.AmpmSignalType, int) –

This parameter specifies whether the reference waveform is a modulated signal or tones. The default value is Modulated.

Name (Value)	Description
Modulated (0)	The reference waveform is a cellular or connectivity standard signal.
Tones (1)	The reference waveform is continuous signals comprising of one or more tones.

Returns:

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

Return type:

int

configure_synchronization_method(selector_string, synchronization_method)[source]

Configures the synchronization method used to synchronize the reference waveform and acquired waveform.

Parameters:

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

synchronization_method (enums.AmpmSynchronizationMethod, int) –

This parameter specifies the method used for time-synchronization of acquired waveform with reference waveform.

Name (Value)	Description
Direct (1)	Synchronizes the acquired and reference waveforms assuming that sample rate is sufficient to prevent aliasing in intermediate operations. This method is recommended when the measurement sampling rate is high.
Alias Protected (2)	Synchronizes the acquired and reference waveforms while ascertaining that intermediate operations are not impacted by aliasing. This method is recommended for non-contiguous carriers separated by a large gap, and/or when the measurement sampling rate is low. Refer to AMPM concept help 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

configure_threshold(selector_string, threshold_enabled, threshold_level, threshold_type)[source]

Configures the threshold level for the samples that need to be considered for the AMPM measurement.

Parameters:

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

threshold_enabled (enums.AmpmThresholdEnabled, int) –

This parameter specifies whether to enable thresholding of the acquired samples to be used for the measurement. The default value is False.

Name (Value)	Description
False (0)	All samples are considered for the measurement.
True (1)	The samples above the threshold level specified in the Threshold Level parameter are considered for the measurement.

threshold_level (float) – This parameter specifies either the relative or absolute threshold power level based on the value of the Threshold Type parameter. The default value is -20 dB.
threshold_type (enums.AmpmThresholdType, int) –
This parameter specifies the reference for the power level used for thresholding. The default value is Relative.

Name (Value)

Description

Relative (0)

The threshold is relative to the peak power, in dB, of the acquired samples.

Absolute (1)

The threshold is the absolute power, in dBm.

Returns:

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

Return type:

int

get_all_traces_enabled(selector_string)[source]

Gets whether to enable the traces to be stored and retrieved after performing the AMPM 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 AMPM 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_am_to_am_curve_fit_order(selector_string)[source]

Gets the degree of the polynomial used to approximate the AM-to-AM characteristic of the device under test (DUT).

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the degree of the polynomial used to approximate the AM-to-AM characteristic of the device under test (DUT).
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_am_to_am_curve_fit_type(selector_string)[source]

Gets the polynomial approximation cost-function of the device under test AM-to-AM characteristic.

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 Least Absolute Residual.

Name (Value)	Description
Least Square (0)	The measurement minimizes the energy of the polynomial approximation error.
Least Absolute Residual (1)	The measurement minimizes the magnitude of the polynomial approximation error.
Bisquare (2)	The measurement excludes the effect of data outliers while minimizing the energy of the polynomial approximation error.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AmpmAMToAMCurveFitType):: Specifies the polynomial approximation cost-function of the device under test AM-to-AM characteristic.
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_am_to_am_enabled(selector_string)[source]

Gets whether to enable the results that rely on the AM to AM characteristics.

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)

Disables the computation of following scalar results and traces. Empty array is returned if the disabled result is an array. NaN is returned otherwise. The following scalar results are disabled: AMPM Results Mean Linear Gain AMPM Results 1 dB Compression Point AMPM Results Input Compression Point AMPM Results Output Compression Point AMPM Results Gain Error Range AMPM Results AM to AM Curve Fit Residual AMPM Results AM to AM Curve Fit Coeff The following traces are disabled: Measured AM to AM Curve Fit AM to AM Relative Power Trace

True (1)

Enables the computation of AM to AM results and traces.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AmpmAMToAMEnabled):: Specifies whether to enable the results that rely on the AM to AM characteristics.
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_am_to_pm_curve_fit_order(selector_string)[source]

Gets the degree of the polynomial used to approximate the AM-to-PM characteristic of the device under test.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the degree of the polynomial used to approximate the AM-to-PM characteristic of the device under test.
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_am_to_pm_curve_fit_type(selector_string)[source]

Gets the polynomial approximation cost-function of the device under test AM-to-PM characteristic.

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 Least Absolute Residual.

Name (Value)	Description
Least Square (0)	The measurement minimizes the energy of the polynomial approximation error.
Least Absolute Residual (1)	The measurement minimizes the magnitude of the polynomial approximation error.
Bisquare (2)	The measurement excludes the effect of data outliers while minimizing the energy of the polynomial approximation error.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AmpmAMToPMCurveFitType):: Specifies the polynomial approximation cost-function of the device under test AM-to-PM characteristic.
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_am_to_pm_enabled(selector_string)[source]

Gets whether to enable the results that rely on AM to PM characteristics.

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)

Disables the computation of following scalar results and traces. Empty array is returned if the disabled result is an array. NaN is returned otherwise. The following scalar results are disabled: AMPM Results Mean Phase Error AMPM Results Phase Error Range AMPM Results AM to PM Curve Fit Residual AMPM Results AM to PM Curve Fit Coefficients The following traces are disabled: Measured AM to PM Curve Fit AM to PM Relative Phase Trace

True (1)

Enables the computation of AM to PM results and traces.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AmpmAMToPMEnabled):: Specifies whether to enable the results that rely on AM to PM characteristics.
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_auto_carrier_detection_enabled(selector_string)[source]

Gets if auto detection of carrier offset and carrier bandwidth is enabled.

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)	Disables auto detection of carrier offset and carrier bandwidth.
True (1)	Enables auto detection of carrier offset and carrier bandwidth.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AmpmAutoCarrierDetectionEnabled):: Specifies if auto detection of carrier offset and carrier bandwidth is enabled.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_averaging_count(selector_string)[source]

Gets the number of acquisitions used for averaging when you set the AVERAGING_ENABLED attribute to True.

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

The default value is 10.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of acquisitions used for averaging when you set the AVERAGING_ENABLED attribute to True.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_averaging_enabled(selector_string)[source]

Gets whether to enable averaging for the AMPM 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 AMPM measurement uses the AMPM Averaging Count attribute as the number of acquisitions over which the signal for the AMPM measurement is averaged.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AmpmAveragingEnabled):: Specifies whether to enable averaging for the AMPM 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_bandwidth(selector_string)[source]

Gets the carrier bandwidth when you set the AUTO_CARRIER_DETECTION_ENABLED attribute to False. This value is expressed in Hz.

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

The default value is 20 MHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the carrier bandwidth when you set the AUTO_CARRIER_DETECTION_ENABLED 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_carrier_offset(selector_string)[source]

Gets the carrier offset when you set the AUTO_CARRIER_DETECTION_ENABLED attribute to False. This value is expressed in Hz.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the carrier offset when you set the AUTO_CARRIER_DETECTION_ENABLED 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_compression_point_enabled(selector_string)[source]

Enables computation of compression points corresponding to the respective compression levels specified by the COMPRESSION_POINT_LEVEL attribute.

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

The default value is False.

Name (Value)	Description
False (0)	Disables computation of compression points.
True (1)	Enables computation of compression points.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AmpmCompressionPointEnabled):: Enables computation of compression points corresponding to the respective compression levels specified by the COMPRESSION_POINT_LEVEL attribute.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_compression_point_gain_reference(selector_string)[source]

Gets the gain reference for compression point calculation.

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
Auto (0)	Measurement computes the gain reference to be used for compression point calculation. The computed gain reference is also returned as AMPM Results Mean Linear Gain result.
Reference Power (1)	Measurement uses the gain corresponding to the reference power that you specify for the AMPM Compression Point Gain Ref Pwr attribute as gain reference. The reference power can be configured as either input or output power based on the value of the AMPM Ref Pwr Type attribute.
Max Gain (2)	Measurement uses the maximum gain as gain reference for compression point calculation.
User Defined (3)	Measurement uses the gain that you specify for the AMPM Compression Point User Gain attribute as gain reference for compression point calculation.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AmpmCompressionPointGainReference):: Specifies the gain reference for compression point calculation.
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_compression_point_gain_reference_power(selector_string)[source]

Gets the reference power corresponding to the gain reference to be used for compression point calculation when you set the COMPRESSION_POINT_GAIN_REFERENCE attribute to Reference Power. The reference power can be configured as either input or output power based on the value of the REFERENCE_POWER_TYPE attribute. This value is expressed in dBm.

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 reference power corresponding to the gain reference to be used for compression point calculation when you set the COMPRESSION_POINT_GAIN_REFERENCE attribute to Reference Power. The reference power can be configured as either input or output power based on the value of the REFERENCE_POWER_TYPE attribute. This value is expressed in dBm.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_compression_point_level(selector_string)[source]

Gets the compression levels for which the compression points are computed when you set the COMPRESSION_POINT_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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the compression levels for which the compression points are computed when you set the COMPRESSION_POINT_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_compression_point_user_gain(selector_string)[source]

Gets the gain to be used as the gain reference for compression point calculation when you set the COMPRESSION_POINT_GAIN_REFERENCE attribute to User Defined. This value is expressed in dB.

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 gain to be used as the gain reference for compression point calculation when you set the COMPRESSION_POINT_GAIN_REFERENCE attribute to User Defined. This value is expressed in dB.
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_dut_average_input_power(selector_string)[source]

Gets the average power of the signal at the input port of the device under test. This value is expressed in dBm.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the average power of the signal at the input port of the device under test. This value is expressed in dBm.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_equalizer_filter_length(selector_string)[source]

Gets the length of the equalizer filter. The measurement maintains the filter length as an odd number by incrementing any even numbered value by one.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the length of the equalizer filter. The measurement maintains the filter length as an odd number by incrementing any even numbered value by one.
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_equalizer_mode(selector_string)[source]

Gets whether the measurement equalizes the channel.

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

Name (Value)	Description
Off (0)	Equalization is not performed.
Train (1)	The equalizer is turned on to compensate for the effect of the channel.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AmpmEqualizerMode):: Specifies whether the measurement equalizes the 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_evm_enabled(selector_string)[source]

Gets whether to enable the MEAN_RMS_EVM attribute.

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

The default value is True.

Name (Value)	Description
False (0)	Disables EVM computation. NaN is returned as Mean RMS EVM.
True (1)	Enables EVM computation.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AmpmEvmEnabled):: Specifies whether to enable the MEAN_RMS_EVM attribute.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_frequency_offset_correction_enabled(selector_string)[source]

Enables frequency offset correction for the 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 True.

Name (Value)	Description
False (0)	The measurement does not perform frequency offset correction.
True (1)	The measurement computes and corrects any frequency offset between the reference and the acquired waveforms.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AmpmFrequencyOffsetCorrectionEnabled):: Enables frequency offset correction for the 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_iq_origin_offset_correction_enabled(selector_string)[source]

Enables IQ origin offset correction for the measurement.

When you set this attribute is set to True, the measurement computes and corrects any origin offset between the reference and the acquired waveforms. When you set this attribute to False, origin offset correction is not performed.

The default value is True.

Name (Value)	Description
False (0)	Disables IQ origin offset correction.
True (1)	Enables IQ origin offset correction.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AmpmIQOriginOffsetCorrectionEnabled):: Enables IQ origin offset correction for the 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_maximum_timing_error(selector_string)[source]

Gets the maximum time alignment error expected between the acquired and the reference waveforms. 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.00002.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the maximum time alignment error expected between the acquired and the reference waveforms. This value is expressed in seconds.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_measurement_enabled(selector_string)[source]

Gets whether to enable the AMPM 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 AMPM 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_interval(selector_string)[source]

Gets the duration of the reference waveform considered for the AMPM measurement. When the reference waveform contains an idle duration, the AMPM measurement neglects the idle samples in the reference waveform leading up to the start of the first active portion of the reference waveform. 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 100E-6.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the duration of the reference waveform considered for the AMPM measurement. When the reference waveform contains an idle duration, the AMPM measurement neglects the idle samples in the reference waveform leading up to the start of the first active portion of the reference waveform. This value is expressed in seconds.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_measurement_sample_rate(selector_string)[source]

Gets the acquisition sample rate when you set the MEASUREMENT_SAMPLE_RATE_MODE attribute to User. This value is expressed in samples per second (S/s).

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 120,000,000.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the acquisition sample rate when you set the MEASUREMENT_SAMPLE_RATE_MODE attribute to User. This value is expressed in samples per second (S/s).
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_sample_rate_mode(selector_string)[source]

Gets whether the acquisition sample rate is based on the reference waveform.

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 Reference Waveform.

Name (Value)	Description
User (0)	The acquisition sample rate is defined by the value of the AMPM Meas Sample Rate attribute.
Reference Waveform (1)	The acquisition sample rate is set to match the sample rate of the reference waveform.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AmpmMeasurementSampleRateMode):: Specifies whether the acquisition sample rate is based on the reference waveform.
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 AMPM measurement.

The number of threads can range from 1 to the number of physical cores. However, 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 AMPM measurement.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_number_of_carriers(selector_string)[source]

Gets the number of carriers in the reference waveform when you set the AUTO_CARRIER_DETECTION_ENABLED 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 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of carriers in the reference waveform when you set the AUTO_CARRIER_DETECTION_ENABLED 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_reference_power_type(selector_string)[source]

Gets the reference power used for AM to AM and AM to PM traces.

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

Name (Value)	Description
Input (0)	The instantaneous powers at the input port of device under test (DUT) forms the x-axis of AM to AM and AM to PM traces.
Output (1)	The instantaneous powers at the output port of DUT forms the x-axis of AM to AM and AM to PM traces.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AmpmReferencePowerType):: Specifies the reference power used for AM to AM and AM to PM traces.
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_signal_type(selector_string)[source]

Gets whether the reference waveform is a modulated signal or a combination of one or more sinusoidal signals. To time-align the sinusoidal reference waveform to the acquired signal, set the AMPM Signal Type attribute to Tones, which switches the AMPM measurement alignment algorithm.

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

Name (Value)	Description
Modulated (0)	The reference waveform is a cellular or connectivity standard signal.
Tones (1)	The reference waveform is a continuous signal comprising of one or more tones.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AmpmSignalType):: Specifies whether the reference waveform is a modulated signal or a combination of one or more sinusoidal signals. To time-align the sinusoidal reference waveform to the acquired signal, set the AMPM Signal Type attribute to Tones, which switches the AMPM measurement alignment algorithm.
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_synchronization_method(selector_string)[source]

Gets the method used for synchronization of acquired waveform with reference waveform.

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

Name (Value)	Description
Direct (1)	Synchronizes the acquired and reference waveforms assuming that sample rate is sufficient to prevent aliasing in intermediate operations. This method is recommended when the measurement sampling rate is high.
Alias Protected (2)	Synchronizes the acquired and reference waveforms while ascertaining that intermediate operations are not impacted by aliasing. This method is recommended for non-contiguous carriers separated by a large gap, and/or when the measurement sampling rate is low. Refer to AMPM concept help for more information.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AmpmSynchronizationMethod):: Specifies the method used for synchronization of acquired waveform with reference waveform.
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_threshold_definition(selector_string)[source]

Gets the definition to use for thresholding acquired and reference waveform.

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 Reference Power Type.

Name (Value)

Description

Input AND Output (0)

Corresponding acquired and reference waveform samples are used for AMPM measurement when both samples are greater or equal to the threshold level.

Reference Power Type (1)

Corresponding acquired and reference waveform samples are used for AMPM measurement when reference waveform sample is greater than or equal to the threshold level and AMPM Ref Pwr Type attribute is set to Input. Corresponding acquired and reference waveform samples are used for AMPM measurement when acquired waveform sample is greater than or equal to the threshold level and AMPM Ref Pwr Type attribute is set to Output.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AmpmThresholdDefinition):: Specifies the definition to use for thresholding acquired and reference waveform.
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_threshold_enabled(selector_string)[source]

Gets whether to enable thresholding of the acquired samples used for the AMPM 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 True.

Name (Value)	Description
False (0)	All samples are considered for the AMPM measurement.
True (1)	Samples above the threshold level specified in the AMPM Threshold Level attribute are considered for the AMPM measurement.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AmpmThresholdEnabled):: Specifies whether to enable thresholding of the acquired samples used for the AMPM 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_threshold_level(selector_string)[source]

Gets either the relative or absolute threshold power level, based on the value of the THRESHOLD_TYPE attribute.

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

The default value is -20 dB.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies either the relative or absolute threshold power level, based on the value of the THRESHOLD_TYPE attribute.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_threshold_type(selector_string)[source]

Gets the reference for the power level used for thresholding.

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

Name (Value)	Description
Relative (0)	The threshold is relative to the peak power of the acquired samples.
Absolute (1)	The threshold is the absolute power, in dBm.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.AmpmThresholdType):: Specifies the reference for the power level used for thresholding.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

set_all_traces_enabled(selector_string, value)[source]

Sets whether to enable the traces to be stored and retrieved after performing the AMPM 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 AMPM measurement.

Returns:

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

Return type:

int

set_am_to_am_curve_fit_order(selector_string, value)[source]

Sets the degree of the polynomial used to approximate the AM-to-AM characteristic of the device under test (DUT).

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

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the degree of the polynomial used to approximate the AM-to-AM characteristic of the device under test (DUT).

Returns:

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

Return type:

int

set_am_to_am_curve_fit_type(selector_string, value)[source]

Sets the polynomial approximation cost-function of the device under test AM-to-AM characteristic.

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 Least Absolute Residual.

Name (Value)	Description
Least Square (0)	The measurement minimizes the energy of the polynomial approximation error.
Least Absolute Residual (1)	The measurement minimizes the magnitude of the polynomial approximation error.
Bisquare (2)	The measurement excludes the effect of data outliers while minimizing the energy of the polynomial approximation error.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AmpmAMToAMCurveFitType, int) – Specifies the polynomial approximation cost-function of the device under test AM-to-AM characteristic.

Returns:

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

Return type:

int

set_am_to_am_enabled(selector_string, value)[source]

Sets whether to enable the results that rely on the AM to AM characteristics.

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)

Disables the computation of following scalar results and traces. Empty array is returned if the disabled result is an array. NaN is returned otherwise. The following scalar results are disabled: AMPM Results Mean Linear Gain AMPM Results 1 dB Compression Point AMPM Results Input Compression Point AMPM Results Output Compression Point AMPM Results Gain Error Range AMPM Results AM to AM Curve Fit Residual AMPM Results AM to AM Curve Fit Coeff The following traces are disabled: Measured AM to AM Curve Fit AM to AM Relative Power Trace

True (1)

Enables the computation of AM to AM results and traces.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AmpmAMToAMEnabled, int) – Specifies whether to enable the results that rely on the AM to AM characteristics.

Returns:

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

Return type:

int

set_am_to_pm_curve_fit_order(selector_string, value)[source]

Sets the degree of the polynomial used to approximate the AM-to-PM characteristic of the device under test.

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

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the degree of the polynomial used to approximate the AM-to-PM characteristic of the device under test.

Returns:

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

Return type:

int

set_am_to_pm_curve_fit_type(selector_string, value)[source]

Sets the polynomial approximation cost-function of the device under test AM-to-PM characteristic.

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 Least Absolute Residual.

Name (Value)	Description
Least Square (0)	The measurement minimizes the energy of the polynomial approximation error.
Least Absolute Residual (1)	The measurement minimizes the magnitude of the polynomial approximation error.
Bisquare (2)	The measurement excludes the effect of data outliers while minimizing the energy of the polynomial approximation error.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AmpmAMToPMCurveFitType, int) – Specifies the polynomial approximation cost-function of the device under test AM-to-PM characteristic.

Returns:

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

Return type:

int

set_am_to_pm_enabled(selector_string, value)[source]

Sets whether to enable the results that rely on AM to PM characteristics.

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)

Disables the computation of following scalar results and traces. Empty array is returned if the disabled result is an array. NaN is returned otherwise. The following scalar results are disabled: AMPM Results Mean Phase Error AMPM Results Phase Error Range AMPM Results AM to PM Curve Fit Residual AMPM Results AM to PM Curve Fit Coefficients The following traces are disabled: Measured AM to PM Curve Fit AM to PM Relative Phase Trace

True (1)

Enables the computation of AM to PM results and traces.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AmpmAMToPMEnabled, int) – Specifies whether to enable the results that rely on AM to PM characteristics.

Returns:

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

Return type:

int

set_auto_carrier_detection_enabled(selector_string, value)[source]

Sets if auto detection of carrier offset and carrier bandwidth is enabled.

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)	Disables auto detection of carrier offset and carrier bandwidth.
True (1)	Enables auto detection of carrier offset and carrier bandwidth.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AmpmAutoCarrierDetectionEnabled, int) – Specifies if auto detection of carrier offset and carrier bandwidth is enabled.

Returns:

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

Return type:

int

set_averaging_count(selector_string, value)[source]

Sets the number of acquisitions used for averaging when you set the AVERAGING_ENABLED attribute to True.

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

The default value is 10.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of acquisitions used for averaging when you set the AVERAGING_ENABLED attribute to True.

Returns:

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

Return type:

int

set_averaging_enabled(selector_string, value)[source]

Sets whether to enable averaging for the AMPM 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 AMPM measurement uses the AMPM Averaging Count attribute as the number of acquisitions over which the signal for the AMPM measurement is averaged.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AmpmAveragingEnabled, int) – Specifies whether to enable averaging for the AMPM measurement.

Returns:

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

Return type:

int

set_carrier_bandwidth(selector_string, value)[source]

Sets the carrier bandwidth when you set the AUTO_CARRIER_DETECTION_ENABLED attribute to False. This value is expressed in Hz.

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

The default value is 20 MHz.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the carrier bandwidth when you set the AUTO_CARRIER_DETECTION_ENABLED 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_carrier_offset(selector_string, value)[source]

Sets the carrier offset when you set the AUTO_CARRIER_DETECTION_ENABLED attribute to False. This value is expressed in Hz.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the carrier offset when you set the AUTO_CARRIER_DETECTION_ENABLED 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_compression_point_enabled(selector_string, value)[source]

Enables computation of compression points corresponding to the respective compression levels specified by the COMPRESSION_POINT_LEVEL attribute.

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

The default value is False.

Name (Value)	Description
False (0)	Disables computation of compression points.
True (1)	Enables computation of compression points.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AmpmCompressionPointEnabled, int) – Enables computation of compression points corresponding to the respective compression levels specified by the COMPRESSION_POINT_LEVEL attribute.

Returns:

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

Return type:

int

set_compression_point_gain_reference(selector_string, value)[source]

Sets the gain reference for compression point calculation.

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
Auto (0)	Measurement computes the gain reference to be used for compression point calculation. The computed gain reference is also returned as AMPM Results Mean Linear Gain result.
Reference Power (1)	Measurement uses the gain corresponding to the reference power that you specify for the AMPM Compression Point Gain Ref Pwr attribute as gain reference. The reference power can be configured as either input or output power based on the value of the AMPM Ref Pwr Type attribute.
Max Gain (2)	Measurement uses the maximum gain as gain reference for compression point calculation.
User Defined (3)	Measurement uses the gain that you specify for the AMPM Compression Point User Gain attribute as gain reference for compression point calculation.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AmpmCompressionPointGainReference, int) – Specifies the gain reference for compression point calculation.

Returns:

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

Return type:

int

set_compression_point_gain_reference_power(selector_string, value)[source]

Sets the reference power corresponding to the gain reference to be used for compression point calculation when you set the COMPRESSION_POINT_GAIN_REFERENCE attribute to Reference Power. The reference power can be configured as either input or output power based on the value of the REFERENCE_POWER_TYPE attribute. This value is expressed in dBm.

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 reference power corresponding to the gain reference to be used for compression point calculation when you set the COMPRESSION_POINT_GAIN_REFERENCE attribute to Reference Power. The reference power can be configured as either input or output power based on the value of the REFERENCE_POWER_TYPE attribute. This value is expressed in dBm.

Returns:

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

Return type:

int

set_compression_point_level(selector_string, value)[source]

Sets the compression levels for which the compression points are computed when you set the COMPRESSION_POINT_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.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the compression levels for which the compression points are computed when you set the COMPRESSION_POINT_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_compression_point_user_gain(selector_string, value)[source]

Sets the gain to be used as the gain reference for compression point calculation when you set the COMPRESSION_POINT_GAIN_REFERENCE attribute to User Defined. This value is expressed in dB.

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 gain to be used as the gain reference for compression point calculation when you set the COMPRESSION_POINT_GAIN_REFERENCE attribute to User Defined. This value is expressed in dB.

Returns:

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

Return type:

int

set_dut_average_input_power(selector_string, value)[source]

Sets the average power of the signal at the input port of the device under test. This value is expressed in dBm.

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

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the average power of the signal at the input port of the device under test. This value is expressed in dBm.

Returns:

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

Return type:

int

set_equalizer_filter_length(selector_string, value)[source]

Sets the length of the equalizer filter. The measurement maintains the filter length as an odd number by incrementing any even numbered value by one.

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

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the length of the equalizer filter. The measurement maintains the filter length as an odd number by incrementing any even numbered value by one.

Returns:

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

Return type:

int

set_equalizer_mode(selector_string, value)[source]

Sets whether the measurement equalizes the channel.

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

Name (Value)	Description
Off (0)	Equalization is not performed.
Train (1)	The equalizer is turned on to compensate for the effect of the channel.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AmpmEqualizerMode, int) – Specifies whether the measurement equalizes the channel.

Returns:

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

Return type:

int

set_evm_enabled(selector_string, value)[source]

Sets whether to enable the MEAN_RMS_EVM attribute.

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

The default value is True.

Name (Value)	Description
False (0)	Disables EVM computation. NaN is returned as Mean RMS EVM.
True (1)	Enables EVM computation.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AmpmEvmEnabled, int) – Specifies whether to enable the MEAN_RMS_EVM attribute.

Returns:

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

Return type:

int

set_frequency_offset_correction_enabled(selector_string, value)[source]

Enables frequency offset correction for the 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 True.

Name (Value)	Description
False (0)	The measurement does not perform frequency offset correction.
True (1)	The measurement computes and corrects any frequency offset between the reference and the acquired waveforms.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AmpmFrequencyOffsetCorrectionEnabled, int) – Enables frequency offset correction for the measurement.

Returns:

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

Return type:

int

set_iq_origin_offset_correction_enabled(selector_string, value)[source]

Enables IQ origin offset correction for the measurement.

When you set this attribute is set to True, the measurement computes and corrects any origin offset between the reference and the acquired waveforms. When you set this attribute to False, origin offset correction is not performed.

The default value is True.

Name (Value)	Description
False (0)	Disables IQ origin offset correction.
True (1)	Enables IQ origin offset correction.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AmpmIQOriginOffsetCorrectionEnabled, int) – Enables IQ origin offset correction for the measurement.

Returns:

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

Return type:

int

set_maximum_timing_error(selector_string, value)[source]

Sets the maximum time alignment error expected between the acquired and the reference waveforms. 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.00002.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the maximum time alignment error expected between the acquired and the reference waveforms. This value is expressed in seconds.

Returns:

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

Return type:

int

set_measurement_enabled(selector_string, value)[source]

Sets whether to enable the AMPM 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 AMPM 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_interval(selector_string, value)[source]

Sets the duration of the reference waveform considered for the AMPM measurement. When the reference waveform contains an idle duration, the AMPM measurement neglects the idle samples in the reference waveform leading up to the start of the first active portion of the reference waveform. 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 100E-6.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the duration of the reference waveform considered for the AMPM measurement. When the reference waveform contains an idle duration, the AMPM measurement neglects the idle samples in the reference waveform leading up to the start of the first active portion of the reference waveform. This value is expressed in seconds.

Returns:

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

Return type:

int

set_measurement_sample_rate(selector_string, value)[source]

Sets the acquisition sample rate when you set the MEASUREMENT_SAMPLE_RATE_MODE attribute to User. This value is expressed in samples per second (S/s).

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 120,000,000.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the acquisition sample rate when you set the MEASUREMENT_SAMPLE_RATE_MODE attribute to User. This value is expressed in samples per second (S/s).

Returns:

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

Return type:

int

set_measurement_sample_rate_mode(selector_string, value)[source]

Sets whether the acquisition sample rate is based on the reference waveform.

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 Reference Waveform.

Name (Value)	Description
User (0)	The acquisition sample rate is defined by the value of the AMPM Meas Sample Rate attribute.
Reference Waveform (1)	The acquisition sample rate is set to match the sample rate of the reference waveform.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AmpmMeasurementSampleRateMode, int) – Specifies whether the acquisition sample rate is based on the reference waveform.

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

The number of threads can range from 1 to the number of physical cores. However, 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 AMPM measurement.

Returns:

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

Return type:

int

set_number_of_carriers(selector_string, value)[source]

Sets the number of carriers in the reference waveform when you set the AUTO_CARRIER_DETECTION_ENABLED 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 1.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the number of carriers in the reference waveform when you set the AUTO_CARRIER_DETECTION_ENABLED 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_reference_power_type(selector_string, value)[source]

Sets the reference power used for AM to AM and AM to PM traces.

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

Name (Value)	Description
Input (0)	The instantaneous powers at the input port of device under test (DUT) forms the x-axis of AM to AM and AM to PM traces.
Output (1)	The instantaneous powers at the output port of DUT forms the x-axis of AM to AM and AM to PM traces.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AmpmReferencePowerType, int) – Specifies the reference power used for AM to AM and AM to PM traces.

Returns:

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

Return type:

int

set_signal_type(selector_string, value)[source]

Sets whether the reference waveform is a modulated signal or a combination of one or more sinusoidal signals. To time-align the sinusoidal reference waveform to the acquired signal, set the AMPM Signal Type attribute to Tones, which switches the AMPM measurement alignment algorithm.

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

Name (Value)	Description
Modulated (0)	The reference waveform is a cellular or connectivity standard signal.
Tones (1)	The reference waveform is a continuous signal comprising of one or more tones.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AmpmSignalType, int) – Specifies whether the reference waveform is a modulated signal or a combination of one or more sinusoidal signals. To time-align the sinusoidal reference waveform to the acquired signal, set the AMPM Signal Type attribute to Tones, which switches the AMPM measurement alignment algorithm.

Returns:

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

Return type:

int

set_synchronization_method(selector_string, value)[source]

Sets the method used for synchronization of acquired waveform with reference waveform.

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

Name (Value)	Description
Direct (1)	Synchronizes the acquired and reference waveforms assuming that sample rate is sufficient to prevent aliasing in intermediate operations. This method is recommended when the measurement sampling rate is high.
Alias Protected (2)	Synchronizes the acquired and reference waveforms while ascertaining that intermediate operations are not impacted by aliasing. This method is recommended for non-contiguous carriers separated by a large gap, and/or when the measurement sampling rate is low. Refer to AMPM concept help for more information.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AmpmSynchronizationMethod, int) – Specifies the method used for synchronization of acquired waveform with reference waveform.

Returns:

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

Return type:

int

set_threshold_definition(selector_string, value)[source]

Sets the definition to use for thresholding acquired and reference waveform.

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 Reference Power Type.

Name (Value)

Description

Input AND Output (0)

Corresponding acquired and reference waveform samples are used for AMPM measurement when both samples are greater or equal to the threshold level.

Reference Power Type (1)

Corresponding acquired and reference waveform samples are used for AMPM measurement when reference waveform sample is greater than or equal to the threshold level and AMPM Ref Pwr Type attribute is set to Input. Corresponding acquired and reference waveform samples are used for AMPM measurement when acquired waveform sample is greater than or equal to the threshold level and AMPM Ref Pwr Type attribute is set to Output.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AmpmThresholdDefinition, int) – Specifies the definition to use for thresholding acquired and reference waveform.

Returns:

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

Return type:

int

set_threshold_enabled(selector_string, value)[source]

Sets whether to enable thresholding of the acquired samples used for the AMPM 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 True.

Name (Value)	Description
False (0)	All samples are considered for the AMPM measurement.
True (1)	Samples above the threshold level specified in the AMPM Threshold Level attribute are considered for the AMPM measurement.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AmpmThresholdEnabled, int) – Specifies whether to enable thresholding of the acquired samples used for the AMPM measurement.

Returns:

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

Return type:

int

set_threshold_level(selector_string, value)[source]

Sets either the relative or absolute threshold power level, based on the value of the THRESHOLD_TYPE attribute.

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

The default value is -20 dB.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies either the relative or absolute threshold power level, based on the value of the THRESHOLD_TYPE attribute.

Returns:

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

Return type:

int

set_threshold_type(selector_string, value)[source]

Sets the reference for the power level used for thresholding.

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

Name (Value)	Description
Relative (0)	The threshold is relative to the peak power of the acquired samples.
Absolute (1)	The threshold is the absolute power, in dBm.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.AmpmThresholdType, int) – Specifies the reference for the power level used for thresholding.

Returns:

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

Return type:

int