DpdConfiguration

Provides methods to configure the Dpd measurement.

class nirfmxspecan.dpd_configuration.DpdConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the Dpd measurement.

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

Configures averaging for the DPD 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.DpdAveragingEnabled, 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_dpd_model(selector_string, dpd_model)[source]

Specifies the DPD model used by the DPD measurement.

Parameters:

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

dpd_model (enums.DpdModel, int) –

This parameter specifies the DPD model used by the DPD measurement. The default value is Lookup Table.

Name (Value)	Description
Lookup Table (0)	This model computes the complex gain coefficients applied when performing digital predistortion to linearize systems with negligible memory effects.
Memory Polynomial (1)	This model computes the memory polynomial predistortion coefficients used to linearize systems with moderate memory effects.
Generalized Memory Polynomial (2)	This model computes the generalized memory polynomial predistortion coefficients used to linearize systems with significant memory effects.
Decomposed Vector Rotation (3)	This model computes the decomposed vector rotation predistortion coefficients used to linearize wideband systems with significant memory effects.

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 (DUT).

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 of the signal at the input port of the DUT. 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_extract_model_target_waveform(selector_string, x0, dx, target_waveform)[source]

Configures the complex baseband equivalent of the Target waveform desired at the output of the Predistorter Model to be extracted when performing the DPD 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.
target_waveform (numpy.complex64) – This parameter specifies the complex baseband samples, in volts.

Returns:

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

Return type:

int

configure_generalized_memory_polynomial_cross_terms(selector_string, memory_polynomial_lead_order, memory_polynomial_lag_order, memory_polynomial_lead_memory_depth, memory_polynomial_lag_memory_depth, memory_polynomial_maximum_lead, memory_polynomial_maximum_lag)[source]

Configures the cross terms of the generalized memory polynomial when you set the MODEL attribute to Generalized Memory Polynomial. Use the configure_memory_polynomial() method to configure the normal terms in the DPD polynomial, along with configuring the cross terms when you set the DPD Model attribute to Generalized Memory Polynomial.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
memory_polynomial_lead_order (int) – This parameter specifies the lead order cross term of the DPD polynomial when you set the DPD Model attribute to Generalized Memory Polynomial. This value corresponds to K_cin the DPD for the generalized memory polynomial. The default value is 0.
memory_polynomial_lag_order (int) –
This parameter specifies the lag order cross term of the DPD polynomial when you set the DPD Model attribute to Generalized Memory Polynomial. This value corresponds to K_bin the DPD for the generalized memory polynomial. The default value is 0.
memory_polynomial_lead_memory_depth (int) –
This parameter specifies the lead memory depth cross term of the DPD polynomial when you set the DPD Model attribute to Generalized Memory Polynomial. This value corresponds to Q_cin the DPD for the generalized memory polynomial. The value of this parameter must be greater than or equal to the value of the Memory Polynomial Max Lead parameter. The default value is 0.
memory_polynomial_lag_memory_depth (int) –
This parameter specifies the lag memory depth cross term of the DPD polynomial when you set the DPD Model attribute to Generalized Memory Polynomial. This value corresponds to Q_bin the DPD for the generalized memory polynomial. The default value is 0.
memory_polynomial_maximum_lead (int) – This parameter specifies the maximum lead stagger cross term of the DPD polynomial when you set the DPD Model attribute to Generalized Memory Polynomial. This value corresponds to M_cin the equation for the generalized memory polynomial. The default value is 0.
memory_polynomial_maximum_lag (int) – This parameter specifies the maximum lag stagger cross term of the DPD polynomial when you set the DPD Model attribute to Generalized Memory Polynomial. This value corresponds to M_bin the equation for the generalized memory polynomial. The default value is 0.

Returns:

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

Return type:

int

configure_iterative_dpd_enabled(selector_string, iterative_dpd_enabled)[source]

Configures the iterative computation of the DPD polynomial in accordance with the DPD when you set the MODEL attribute to Memory Polynomial or Generalized Memory Polynomial.

Parameters:

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

iterative_dpd_enabled (enums.DpdIterativeDpdEnabled, int) –

This parameter specifies whether to enable iterative computation of the DPD Results DPD Polynomial using DPD. The default value is False.

Name (Value)	Description
False (0)	The DPD Results DPD Polynomial is computed without considering the value of the DPD Previous DPD Polynomial.
True (1)	The DPD Results DPD Polynomial is computed based on the value of the DPD Previous DPD Polynomial.

Returns:

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

Return type:

int

configure_lookup_table_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 approximation method used for polynomial approximation of the AM-to-AM response of the device under test (DUT) when you set the MODEL attribute to Lookup Table.

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 DUT when you set the DPD Model attribute to Lookup Table. The default value is 7.

am_to_am_curve_fit_type (enums.DpdLookupTableAMToAMCurveFitType, int) –

This parameter specifies the polynomial approximation cost-function of the DUT AM-to-AM characteristic when you set the DPD Model attribute to Lookup Table. 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_lookup_table_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 approximation method, used for polynomial approximation of the AM-to-PM response of the device under test (DUT) when you set the MODEL attribute to Lookup Table.

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 DUT when you set the DPD Model attribute to Lookup Table. The default value is 7.

am_to_pm_curve_fit_type (enums.DpdLookupTableAMToPMCurveFitType, int) –

This parameter specifies the polynomial approximation cost-function of the DUT AM-to-PM characteristic when you set the DPD Model attribute to Lookup Table. 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_lookup_table_step_size(selector_string, step_size)[source]

Configures the step size, in dB, of input power levels in the predistortion lookup table when you set the MODEL attribute to Lookup Table.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
step_size (float) – This parameter specifies the step size, in dB, of the input power levels in the predistortion lookup table when you set the DPD Model attribute to Lookup Table. The default value is 0.1 dB.

Returns:

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

Return type:

int

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

Configures the threshold level for the samples that are considered for the DPD measurement when you set the MODEL attribute to Lookup Table. Set the Threshold Enabled parameter to True to reject low-power signals affected by noise and distortion.

Parameters:

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

threshold_enabled (enums.DpdLookupTableThresholdEnabled, 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.DpdLookupTableThresholdType, 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

configure_lookup_table_type(selector_string, lookup_table_type)[source]

Configuers the type of DPD Lookup Table.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
lookup_table_type (enums.DpdLookupTableType, int) –
This parameter specifies the type of the DPD lookup table (LUT). The default value is Log.

Name (Value)

Description

Log (0)

Input powers in the LUT are specified in dBm.

Linear (1)

Input powers in the LUT are specified in watts.

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 DPD 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 DPD 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.DpdMeasurementSampleRateMode, int) –

This parameter specifies the acquisition sample rate configuration mode. The default value is User.

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. Actual sample rate may differ from requested sample rate in order to ensure a waveform is phase continuous. 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_memory_polynomial(selector_string, memory_polynomial_order, memory_polynomial_memory_depth)[source]

Configures the order and memory depth of the DPD polynomial when you set the MODEL attribute to Memory Polynomial or Generalized Memory Polynomial.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
memory_polynomial_order (int) – This parameter specifies the order of the DPD polynomial when you set the DPD Model attribute to Memory Polynomial or Generalized Memory Polynomial. This value corresponds to K_ain the equation for the generalized memory polynomial. The default value is 3.
memory_polynomial_memory_depth (int) – This parameter specifies the memory depth of the DPD polynomial when you set the DPD Model attribute to Memory Polynomial or Generalized Memory Polynomial. This value corresponds to Q_ain the equation for the generalized memory polynomial. The default value is 0.

Returns:

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

Return type:

int

configure_previous_dpd_polynomial(selector_string, previous_dpd_polynomial)[source]

Configures the previous DPD polynomial when you set the MODEL attribute to Memory Polynomial or Generalized Memory Polynomial. Set the ITERATIVE_DPD_ENABLED attribute to True, to apply the previous DPD polynomial on the reference waveform, which is used to compute the value of the DPD polynomial for the current iteration.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
previous_dpd_polynomial (numpy.complex64) – This parameter specifies the value of the previous DPD polynomial.

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 complex baseband equivalent of the RF signal applied at the input port of the DUT when performing the DPD 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.DpdReferenceWaveformIdleDurationPresent, 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.DpdSignalType, 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.DpdSynchronizationMethod, 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 DPD 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

get_all_traces_enabled(selector_string)[source]

Gets whether to enable the traces to be stored and retrieved after performing the DPD 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 DPD 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_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.DpdAutoCarrierDetectionEnabled):: 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 DPD 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 DPD measurement uses the DPD Averaging Count attribute as the number of acquisitions over which the signal for the DPD measurement is averaged.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

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

Gets the average power of the signal at the device under test input port. 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 device under test input port. 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_dvr_ddr_enabled(selector_string)[source]

Gets whether to enable the Dynamic Deviation Reduction (DDR) terms which are a subset of Decomposed Vector Rotation Model when you set the MODEL attribute to Decomposed Vector Rotation. For more details, refer to the DPD for the decomposed vector rotation model.

You do not need to use a selector string to configure or read this attribute 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 Dynamic Deviation Reduction (DDR) terms which are a subset of Decomposed Vector Rotation model are disabled.
True (1)	The Dynamic Deviation Reduction (DDR) terms which are a subset of Decomposed Vector Rotation model are enabled.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DpdDvrDdrEnabled):: Specifies whether to enable the Dynamic Deviation Reduction (DDR) terms which are a subset of Decomposed Vector Rotation Model when you set the MODEL attribute to Decomposed Vector Rotation. For more details, refer to the DPD for the decomposed vector rotation model.
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_dvr_linear_memory_depth(selector_string)[source]

Gets the linear memory depth of the Decomposed Vector Rotation model when you set the MODEL attribute to Decomposed Vector Rotation. This value corresponds to *M_l*in the DPD for the decomposed vector rotation model.

You do not need to use a selector string to configure or read this attribute 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. This value must be greater than or equal to 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the linear memory depth of the Decomposed Vector Rotation model when you set the MODEL attribute to Decomposed Vector Rotation. This value corresponds to *M_l*in the DPD for the decomposed vector rotation model.
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_dvr_nonlinear_memory_depth(selector_string)[source]

Gets the nonlinear memory depth of the Decomposed Vector Rotation model when you set the MODEL attribute to Decomposed Vector Rotation. This value corresponds to *M_nl*in the DPD for the decomposed vector rotation model.

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

The default value is 2. This value must be greater than or equal to 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the nonlinear memory depth of the Decomposed Vector Rotation model when you set the MODEL attribute to Decomposed Vector Rotation. This value corresponds to *M_nl*in the DPD for the decomposed vector rotation model.
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_dvr_number_of_segments(selector_string)[source]

Gets the number of segments of the Decomposed Vector Rotation model when you set the MODEL attribute to Decomposed Vector Rotation. This value corresponds to K in the DPD for the Decomposed Vector Rotation model.

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

The default value is 4. This value must be greater than or equal to 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the number of segments of the Decomposed Vector Rotation model when you set the MODEL attribute to Decomposed Vector Rotation. This value corresponds to K in the DPD for the Decomposed Vector Rotation model.
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]

Gets whether to enable frequency offset correction for the DPD 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 computes and corrects any frequency offset between the reference and the acquired waveforms.
True (1)	The measurement does not perform frequency offset correction.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DpdFrequencyOffsetCorrectionEnabled):: Specifies whether to enable frequency offset correction for the DPD 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 the IQ origin offset correction for the measurement.

When you set this attribute 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.DpdIQOriginOffsetCorrectionEnabled):: Enables the 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_iterative_dpd_enabled(selector_string)[source]

Gets whether to enable iterative computation of the DPD Results DPD Polynomial using DPD.

You do not need to use a selector string to configure or read this attribute 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)	RFmx computes the DPD Results DPD Polynomial without considering the value of the DPD Previous DPD Polynomial.
True (1)	RFmx computes the DPD Results DPD Polynomial based on the value of the DPD Previous DPD Polynomial.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DpdIterativeDpdEnabled):: Specifies whether to enable iterative computation of the DPD Results DPD Polynomial using DPD.
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_lookup_table_am_to_am_curve_fit_order(selector_string)[source]

Gets the degree of the polynomial used to approximate the device under test AM-to-AM characteristic when you set the MODEL attribute to Lookup 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 7.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the degree of the polynomial used to approximate the device under test AM-to-AM characteristic when you set the MODEL attribute to Lookup 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_lookup_table_am_to_am_curve_fit_type(selector_string)[source]

Gets the polynomial approximation cost-function of the device under test AM-to-AM characteristic when you set the MODEL attribute to Lookup 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 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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DpdLookupTableAMToAMCurveFitType):: Specifies the polynomial approximation cost-function of the device under test AM-to-AM characteristic when you set the MODEL attribute to Lookup 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_lookup_table_am_to_pm_curve_fit_order(selector_string)[source]

Gets the degree of the polynomial used to approximate the device under test AM-to-PM characteristic when you set the MODEL attribute to Lookup 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 7.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the degree of the polynomial used to approximate the device under test AM-to-PM characteristic when you set the MODEL attribute to Lookup 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_lookup_table_am_to_pm_curve_fit_type(selector_string)[source]

Gets the polynomial approximation cost-function of the device under test AM-to-PM characteristic when you set the MODEL attribute to Lookup 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 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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DpdLookupTableAMToPMCurveFitType):: Specifies the polynomial approximation cost-function of the device under test AM-to-PM characteristic when you set the MODEL attribute to Lookup 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_lookup_table_step_size(selector_string)[source]

Gets the step size of the input power levels in the predistortion lookup table when you set the MODEL attribute to Lookup Table. 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 0.1 dB.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):: Specifies the step size of the input power levels in the predistortion lookup table when you set the MODEL attribute to Lookup Table. 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_lookup_table_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 Input.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

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

Gets whether to enable thresholding of the acquired samples to be used for the DPD measurement when you set the MODEL attribute to Lookup 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 True.

Name (Value)	Description
False (0)	All samples are considered for the DPD measurement.
True (1)	Only samples above the threshold level which you specify in the DPD LUT Threshold Level attribute are considered for the DPD measurement.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DpdLookupTableThresholdEnabled):: Specifies whether to enable thresholding of the acquired samples to be used for the DPD measurement when you set the MODEL attribute to Lookup 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_lookup_table_threshold_level(selector_string)[source]

Gets either the relative or absolute threshold power level based on the value of the LOOKUP_TABLE_THRESHOLD_TYPE attribute. This value is expressed in dB or 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 either the relative or absolute threshold power level based on the value of the LOOKUP_TABLE_THRESHOLD_TYPE attribute. This value is expressed in dB or 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_lookup_table_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.DpdLookupTableThresholdType):: 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)

get_lookup_table_type(selector_string)[source]

Gets the type of the DPD lookup table (LUT).

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

The default value is Log.

Name (Value)	Description
Log (0)	Input powers in the LUT are specified in dBm.
Linear (1)	Input powers in the LUT are specified in watts.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DpdLookupTableType):: Specifies the type of the DPD lookup table (LUT).
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 DPD 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 DPD 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 DPD measurement. When the reference waveform contains an idle duration, the DPD 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 DPD measurement. When the reference waveform contains an idle duration, the DPD 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_mode(selector_string)[source]

Gets if the training waveform required for the extraction of the DPD model coefficients is acquired from the hardware or is configured by the user.

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

The default value is Acquire and Extract.

Name (Value)	Description
Acquire and Extract (0)	The measurement acquires the training waveform required for the extraction of the DPD model coefficients from the hardware and then computes the model coefficients.
Extract Only (1)	The measurement uses the user configured training waveform required for the extraction of the DPD model coefficients.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DpdMeasurementMode):: Specifies if the training waveform required for the extraction of the DPD model coefficients is acquired from the hardware or is configured by the user.
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). Actual sample rate may differ from requested sample rate in order to ensure a waveform is phase continuous.

You do not need to use a selector string to configure or read this attribute 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 MHz.

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). Actual sample rate may differ from requested sample rate in order to ensure a waveform is phase continuous.
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 the acquisition sample rate configuration mode.

You do not need to use a selector string to configure or read this attribute 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 DPD 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.DpdMeasurementSampleRateMode):: Specifies the acquisition sample rate configuration mode.
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_memory_polynomial_lag_memory_depth(selector_string)[source]

Gets the lag memory depth cross term of the DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial. This term value corresponds to *Q_b*in the DPD for the generalized memory polynomial.

You do not need to use a selector string to configure or read this attribute 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 (int):: Specifies the lag memory depth cross term of the DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial. This term value corresponds to *Q_b*in the DPD for the generalized memory polynomial.
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_memory_polynomial_lag_order(selector_string)[source]

Gets the lag order cross term of the DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial. This term value corresponds to *K_b*in the DPD for the generalized memory polynomial.

You do not need to use a selector string to configure or read this attribute 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 (int):: Specifies the lag order cross term of the DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial. This term value corresponds to *K_b*in the DPD for the generalized memory polynomial.
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_memory_polynomial_lag_order_type(selector_string)[source]

Configures the type of terms of the lag order DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial.

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

The default value is All Orders.

Name (Value)	Description
All Orders (0)	The memory polynomial will compute all the terms for the given order.
Odd Orders Only (1)	The memory polynomial will compute the non-zero coefficients only for the odd terms.
Even Orders Only (2)	The memory polynomial will compute the non-zero coefficents only for the even terms.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DpdMemoryPolynomialLagOrderType):: Configures the type of terms of the lag order DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial.
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_memory_polynomial_lead_memory_depth(selector_string)[source]

Gets the lead memory depth cross term of the DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial. This term value corresponds to *Q_c*in the DPD for the generalized memory polynomial. The value of the DPD Mem Poly Lead Mem Depth attribute must be greater than or equal to the value of the MEMORY_POLYNOMIAL_MAXIMUM_LEAD 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 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the lead memory depth cross term of the DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial. This term value corresponds to *Q_c*in the DPD for the generalized memory polynomial. The value of the DPD Mem Poly Lead Mem Depth attribute must be greater than or equal to the value of the MEMORY_POLYNOMIAL_MAXIMUM_LEAD 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_memory_polynomial_lead_order(selector_string)[source]

Gets the lead order cross term of the DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial. This term value corresponds to *K_c*in the DPD for the generalized memory polynomial.

You do not need to use a selector string to configure or read this attribute 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 (int):: Specifies the lead order cross term of the DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial. This term value corresponds to *K_c*in the DPD for the generalized memory polynomial.
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_memory_polynomial_lead_order_type(selector_string)[source]

Configures the type of terms of the lead order DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial.

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

The default value is All Orders.

Name (Value)	Description
All Orders (0)	The memory polynomial will compute all the terms for the given order.
Odd Orders Only (1)	The memory polynomial will compute the non-zero coefficients only for the odd terms.
Even Orders Only (2)	The memory polynomial will compute the non-zero coefficents only for the even terms.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DpdMemoryPolynomialLeadOrderType):: Configures the type of terms of the lead order DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial.
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_memory_polynomial_maximum_lag(selector_string)[source]

Gets the maximum lag stagger cross term of the DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial. This term value corresponds to *M_b*in the DPD for the generalized memory polynomial.

You do not need to use a selector string to configure or read this attribute 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 (int):: Specifies the maximum lag stagger cross term of the DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial. This term value corresponds to *M_b*in the DPD for the generalized memory polynomial.
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_memory_polynomial_maximum_lead(selector_string)[source]

Gets the maximum lead stagger cross term of the DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial. This term value corresponds to *M_c*in the DPD for the generalized memory polynomial.

You do not need to use a selector string to configure or read this attribute 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 (int):: Specifies the maximum lead stagger cross term of the DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial. This term value corresponds to *M_c*in the DPD for the generalized memory polynomial.
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_memory_polynomial_memory_depth(selector_string)[source]

Gets the memory depth of the DPD polynomial when you set the MODEL attribute to Memory Polynomial or Generalized Memory Polynomial. This depth value corresponds to Q_ain the DPD for the generalized memory polynomial.

You do not need to use a selector string to configure or read this attribute 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 (int):: Specifies the memory depth of the DPD polynomial when you set the MODEL attribute to Memory Polynomial or Generalized Memory Polynomial. This depth value corresponds to Q_ain the DPD for the generalized memory polynomial.
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_memory_polynomial_order(selector_string)[source]

Gets the order of the DPD polynomial when you set the MODEL attribute to Memory Polynomial or Generalized Memory Polynomial. This order value corresponds to K_ain the DPD for the generalized memory polynomial.

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

The default value is 3.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the order of the DPD polynomial when you set the MODEL attribute to Memory Polynomial or Generalized Memory Polynomial. This order value corresponds to K_ain the DPD for the generalized memory polynomial.
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_memory_polynomial_order_type(selector_string)[source]

Configures the type of terms of the DPD polynomial when you set the MODEL attribute to Memory Polynomial or Generalized Memory Polynomial.

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

The default value is All Orders.

Name (Value)	Description
All Orders (0)	The memory polynomial will compute all the terms for the given order.
Odd Orders Only (1)	The memory polynomial will compute the non-zero coefficients only for the odd terms.
Even Orders Only (2)	The memory polynomial will compute the non-zero coefficents only for the first linear term and all even terms.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DpdMemoryPolynomialOrderType):: Configures the type of terms of the DPD polynomial when you set the MODEL attribute to Memory Polynomial or Generalized Memory Polynomial.
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_model(selector_string)[source]

Gets the DPD model used by the DPD 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 Lookup Table.

Name (Value)	Description
Lookup Table (0)	This model computes the complex gain coefficients applied when performing digital predistortion to linearize systems with negligible memory effects.
Memory Polynomial (1)	This model computes the memory polynomial predistortion coefficients used to linearize systems with moderate memory effects.
Generalized Memory Polynomial (2)	This model computes the generalized memory polynomial predistortion coefficients used to linearize systems with significant memory effects.
Decomposed Vector Rotation (3)	This model computes the Decomposed Vector Rotation model predistortion coefficients used to linearize wideband systems with significant memory effects.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DpdModel):: Specifies the DPD model used by the DPD 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_nmse_enabled(selector_string)[source]

Gets whether to enable the normalized mean-squared error (NMSE) computation.

You do not need to use a selector string to configure or read this attribute 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 NMSE computation. NaN is returned as NMSE.
True (1)	Enables NMSE computation.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DpdNmseEnabled):: Specifies whether to enable the normalized mean-squared error (NMSE) computation.
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 of the DPD measurement.

The number of threads can range from 1 to the number of physical cores. However, the number of threads you set may not all 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 of the DPD 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_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 DPD Signal Type attribute to Tones, which switches the DPD 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 one or more tones.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DpdSignalType):: 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 DPD Signal Type attribute to Tones, which switches the DPD 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 the acquired waveform with 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 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 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 measurement sampling rate is low. Refer to DPD concept help for more information.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

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

Gets the gain expected from the DUT after applying DPD on the input 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 Average Gain.

Name (Value)	Description
Average Gain (0)	The DPD polynomial or lookup table is computed by assuming that the linearized gain expected from the DUT after applying DPD on the input waveform is equal to the average power gain provided by the DUT without DPD.
Linear Region Gain (1)	The DPD polynomial or lookup table is computed by assuming that the linearized gain expected from the DUT after applying DPD on the input waveform is equal to the gain provided by the DUT, without DPD, to the parts of the reference waveform that do not drive the DUT into non-linear gain-expansion or compression regions of its input-output characteristics. The measurement computes the linear region gain as the average gain experienced by the parts of the reference waveform that are below a threshold which is computed as shown in the following equation: Linear region threshold (dBm) = Max {-25, Min {reference waveform power} + 6, DUT Average Input Power -15}
Peak Input Power Gain (2)	The DPD polynomial or lookup table is computed by assuming that the linearized gain expected from the DUT after applying DPD on the input waveform is equal to the average power gain provided by the DUT, without DPD, to all the samples of the reference waveform for which the magnitude is greater than the peak power in the reference waveform (dBm) - 0.5dB.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DpdTargetGainType):: Specifies the gain expected from the DUT after applying DPD on the input 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)

set_all_traces_enabled(selector_string, value)[source]

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

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.DpdAutoCarrierDetectionEnabled, 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 DPD 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 DPD measurement uses the DPD Averaging Count attribute as the number of acquisitions over which the signal for the DPD measurement is averaged.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DpdAveragingEnabled, int) – Specifies whether to enable averaging for the DPD 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_dut_average_input_power(selector_string, value)[source]

Sets the average power of the signal at the device under test input port. 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 device under test input port. 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_dvr_ddr_enabled(selector_string, value)[source]

Sets whether to enable the Dynamic Deviation Reduction (DDR) terms which are a subset of Decomposed Vector Rotation Model when you set the MODEL attribute to Decomposed Vector Rotation. For more details, refer to the DPD for the decomposed vector rotation model.

You do not need to use a selector string to configure or read this attribute 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 Dynamic Deviation Reduction (DDR) terms which are a subset of Decomposed Vector Rotation model are disabled.
True (1)	The Dynamic Deviation Reduction (DDR) terms which are a subset of Decomposed Vector Rotation model are enabled.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DpdDvrDdrEnabled, int) –
Specifies whether to enable the Dynamic Deviation Reduction (DDR) terms which are a subset of Decomposed Vector Rotation Model when you set the MODEL attribute to Decomposed Vector Rotation. For more details, refer to the DPD for the decomposed vector rotation model.

Returns:

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

Return type:

int

set_dvr_linear_memory_depth(selector_string, value)[source]

Sets the linear memory depth of the Decomposed Vector Rotation model when you set the MODEL attribute to Decomposed Vector Rotation. This value corresponds to *M_l*in the DPD for the decomposed vector rotation model.

You do not need to use a selector string to configure or read this attribute 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. This value must be greater than or equal to 0.

Parameters:

selector_string (string) – Pass an empty string.
value (int) –
Specifies the linear memory depth of the Decomposed Vector Rotation model when you set the MODEL attribute to Decomposed Vector Rotation. This value corresponds to *M_l*in the DPD for the decomposed vector rotation model.

Returns:

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

Return type:

int

set_dvr_nonlinear_memory_depth(selector_string, value)[source]

Sets the nonlinear memory depth of the Decomposed Vector Rotation model when you set the MODEL attribute to Decomposed Vector Rotation. This value corresponds to *M_nl*in the DPD for the decomposed vector rotation model.

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

The default value is 2. This value must be greater than or equal to 1.

Parameters:

selector_string (string) – Pass an empty string.
value (int) –
Specifies the nonlinear memory depth of the Decomposed Vector Rotation model when you set the MODEL attribute to Decomposed Vector Rotation. This value corresponds to *M_nl*in the DPD for the decomposed vector rotation model.

Returns:

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

Return type:

int

set_dvr_number_of_segments(selector_string, value)[source]

Sets the number of segments of the Decomposed Vector Rotation model when you set the MODEL attribute to Decomposed Vector Rotation. This value corresponds to K in the DPD for the Decomposed Vector Rotation model.

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

The default value is 4. This value must be greater than or equal to 1.

Parameters:

selector_string (string) – Pass an empty string.
value (int) –
Specifies the number of segments of the Decomposed Vector Rotation model when you set the MODEL attribute to Decomposed Vector Rotation. This value corresponds to K in the DPD for the Decomposed Vector Rotation model.

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]

Sets whether to enable frequency offset correction for the DPD 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 computes and corrects any frequency offset between the reference and the acquired waveforms.
True (1)	The measurement does not perform frequency offset correction.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DpdFrequencyOffsetCorrectionEnabled, int) – Specifies whether to enable frequency offset correction for the DPD 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 the IQ origin offset correction for the measurement.

When you set this attribute 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.DpdIQOriginOffsetCorrectionEnabled, int) – Enables the 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_iterative_dpd_enabled(selector_string, value)[source]

Sets whether to enable iterative computation of the DPD Results DPD Polynomial using DPD.

You do not need to use a selector string to configure or read this attribute 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)	RFmx computes the DPD Results DPD Polynomial without considering the value of the DPD Previous DPD Polynomial.
True (1)	RFmx computes the DPD Results DPD Polynomial based on the value of the DPD Previous DPD Polynomial.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DpdIterativeDpdEnabled, int) –
Specifies whether to enable iterative computation of the DPD Results DPD Polynomial using DPD.

Returns:

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

Return type:

int

set_lookup_table_am_to_am_curve_fit_order(selector_string, value)[source]

Sets the degree of the polynomial used to approximate the device under test AM-to-AM characteristic when you set the MODEL attribute to Lookup 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 7.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the degree of the polynomial used to approximate the device under test AM-to-AM characteristic when you set the MODEL attribute to Lookup Table.

Returns:

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

Return type:

int

set_lookup_table_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 when you set the MODEL attribute to Lookup 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 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.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DpdLookupTableAMToAMCurveFitType, int) – Specifies the polynomial approximation cost-function of the device under test AM-to-AM characteristic when you set the MODEL attribute to Lookup Table.

Returns:

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

Return type:

int

set_lookup_table_am_to_pm_curve_fit_order(selector_string, value)[source]

Sets the degree of the polynomial used to approximate the device under test AM-to-PM characteristic when you set the MODEL attribute to Lookup 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 7.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the degree of the polynomial used to approximate the device under test AM-to-PM characteristic when you set the MODEL attribute to Lookup Table.

Returns:

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

Return type:

int

set_lookup_table_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 when you set the MODEL attribute to Lookup 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 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.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DpdLookupTableAMToPMCurveFitType, int) – Specifies the polynomial approximation cost-function of the device under test AM-to-PM characteristic when you set the MODEL attribute to Lookup Table.

Returns:

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

Return type:

int

set_lookup_table_step_size(selector_string, value)[source]

Sets the step size of the input power levels in the predistortion lookup table when you set the MODEL attribute to Lookup Table. 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 0.1 dB.

Parameters:

selector_string (string) – Pass an empty string.
value (float) – Specifies the step size of the input power levels in the predistortion lookup table when you set the MODEL attribute to Lookup Table. 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_lookup_table_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 Input.

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

Parameters:

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

Sets whether to enable thresholding of the acquired samples to be used for the DPD measurement when you set the MODEL attribute to Lookup 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 True.

Name (Value)	Description
False (0)	All samples are considered for the DPD measurement.
True (1)	Only samples above the threshold level which you specify in the DPD LUT Threshold Level attribute are considered for the DPD measurement.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DpdLookupTableThresholdEnabled, int) – Specifies whether to enable thresholding of the acquired samples to be used for the DPD measurement when you set the MODEL attribute to Lookup Table.

Returns:

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

Return type:

int

set_lookup_table_threshold_level(selector_string, value)[source]

Sets either the relative or absolute threshold power level based on the value of the LOOKUP_TABLE_THRESHOLD_TYPE attribute. This value is expressed in dB or 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 either the relative or absolute threshold power level based on the value of the LOOKUP_TABLE_THRESHOLD_TYPE attribute. This value is expressed in dB or dBm.

Returns:

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

Return type:

int

set_lookup_table_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.DpdLookupTableThresholdType, 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

set_lookup_table_type(selector_string, value)[source]

Sets the type of the DPD lookup table (LUT).

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

The default value is Log.

Name (Value)	Description
Log (0)	Input powers in the LUT are specified in dBm.
Linear (1)	Input powers in the LUT are specified in watts.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DpdLookupTableType, int) – Specifies the type of the DPD lookup table (LUT).

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 DPD 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 DPD 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 DPD measurement. When the reference waveform contains an idle duration, the DPD 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 DPD measurement. When the reference waveform contains an idle duration, the DPD 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_mode(selector_string, value)[source]

Sets if the training waveform required for the extraction of the DPD model coefficients is acquired from the hardware or is configured by the user.

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

The default value is Acquire and Extract.

Name (Value)	Description
Acquire and Extract (0)	The measurement acquires the training waveform required for the extraction of the DPD model coefficients from the hardware and then computes the model coefficients.
Extract Only (1)	The measurement uses the user configured training waveform required for the extraction of the DPD model coefficients.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DpdMeasurementMode, int) – Specifies if the training waveform required for the extraction of the DPD model coefficients is acquired from the hardware or is configured by the user.

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). Actual sample rate may differ from requested sample rate in order to ensure a waveform is phase continuous.

You do not need to use a selector string to configure or read this attribute 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 MHz.

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). Actual sample rate may differ from requested sample rate in order to ensure a waveform is phase continuous.

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 the acquisition sample rate configuration mode.

You do not need to use a selector string to configure or read this attribute 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 DPD 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.DpdMeasurementSampleRateMode, int) – Specifies the acquisition sample rate configuration mode.

Returns:

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

Return type:

int

set_memory_polynomial_lag_memory_depth(selector_string, value)[source]

Sets the lag memory depth cross term of the DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial. This term value corresponds to *Q_b*in the DPD for the generalized memory polynomial.

You do not need to use a selector string to configure or read this attribute 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 (int) –
Specifies the lag memory depth cross term of the DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial. This term value corresponds to *Q_b*in the DPD for the generalized memory polynomial.

Returns:

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

Return type:

int

set_memory_polynomial_lag_order(selector_string, value)[source]

Sets the lag order cross term of the DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial. This term value corresponds to *K_b*in the DPD for the generalized memory polynomial.

You do not need to use a selector string to configure or read this attribute 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 (int) –
Specifies the lag order cross term of the DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial. This term value corresponds to *K_b*in the DPD for the generalized memory polynomial.

Returns:

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

Return type:

int

set_memory_polynomial_lag_order_type(selector_string, value)[source]

Configures the type of terms of the lag order DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial.

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

The default value is All Orders.

Name (Value)	Description
All Orders (0)	The memory polynomial will compute all the terms for the given order.
Odd Orders Only (1)	The memory polynomial will compute the non-zero coefficients only for the odd terms.
Even Orders Only (2)	The memory polynomial will compute the non-zero coefficents only for the even terms.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DpdMemoryPolynomialLagOrderType, int) – Configures the type of terms of the lag order DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial.

Returns:

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

Return type:

int

set_memory_polynomial_lead_memory_depth(selector_string, value)[source]

Sets the lead memory depth cross term of the DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial. This term value corresponds to *Q_c*in the DPD for the generalized memory polynomial. The value of the DPD Mem Poly Lead Mem Depth attribute must be greater than or equal to the value of the MEMORY_POLYNOMIAL_MAXIMUM_LEAD 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 0.

Parameters:

selector_string (string) – Pass an empty string.
value (int) –
Specifies the lead memory depth cross term of the DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial. This term value corresponds to *Q_c*in the DPD for the generalized memory polynomial. The value of the DPD Mem Poly Lead Mem Depth attribute must be greater than or equal to the value of the MEMORY_POLYNOMIAL_MAXIMUM_LEAD attribute.

Returns:

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

Return type:

int

set_memory_polynomial_lead_order(selector_string, value)[source]

Sets the lead order cross term of the DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial. This term value corresponds to *K_c*in the DPD for the generalized memory polynomial.

You do not need to use a selector string to configure or read this attribute 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 (int) –
Specifies the lead order cross term of the DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial. This term value corresponds to *K_c*in the DPD for the generalized memory polynomial.

Returns:

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

Return type:

int

set_memory_polynomial_lead_order_type(selector_string, value)[source]

Configures the type of terms of the lead order DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial.

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

The default value is All Orders.

Name (Value)	Description
All Orders (0)	The memory polynomial will compute all the terms for the given order.
Odd Orders Only (1)	The memory polynomial will compute the non-zero coefficients only for the odd terms.
Even Orders Only (2)	The memory polynomial will compute the non-zero coefficents only for the even terms.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DpdMemoryPolynomialLeadOrderType, int) – Configures the type of terms of the lead order DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial.

Returns:

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

Return type:

int

set_memory_polynomial_maximum_lag(selector_string, value)[source]

Sets the maximum lag stagger cross term of the DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial. This term value corresponds to *M_b*in the DPD for the generalized memory polynomial.

You do not need to use a selector string to configure or read this attribute 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 (int) –
Specifies the maximum lag stagger cross term of the DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial. This term value corresponds to *M_b*in the DPD for the generalized memory polynomial.

Returns:

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

Return type:

int

set_memory_polynomial_maximum_lead(selector_string, value)[source]

Sets the maximum lead stagger cross term of the DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial. This term value corresponds to *M_c*in the DPD for the generalized memory polynomial.

You do not need to use a selector string to configure or read this attribute 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 (int) –
Specifies the maximum lead stagger cross term of the DPD polynomial when you set the MODEL attribute to Generalized Memory Polynomial. This term value corresponds to *M_c*in the DPD for the generalized memory polynomial.

Returns:

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

Return type:

int

set_memory_polynomial_memory_depth(selector_string, value)[source]

Sets the memory depth of the DPD polynomial when you set the MODEL attribute to Memory Polynomial or Generalized Memory Polynomial. This depth value corresponds to Q_ain the DPD for the generalized memory polynomial.

You do not need to use a selector string to configure or read this attribute 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 (int) –
Specifies the memory depth of the DPD polynomial when you set the MODEL attribute to Memory Polynomial or Generalized Memory Polynomial. This depth value corresponds to Q_ain the DPD for the generalized memory polynomial.

Returns:

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

Return type:

int

set_memory_polynomial_order(selector_string, value)[source]

Sets the order of the DPD polynomial when you set the MODEL attribute to Memory Polynomial or Generalized Memory Polynomial. This order value corresponds to K_ain the DPD for the generalized memory polynomial.

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

The default value is 3.

Parameters:

selector_string (string) – Pass an empty string.
value (int) –
Specifies the order of the DPD polynomial when you set the MODEL attribute to Memory Polynomial or Generalized Memory Polynomial. This order value corresponds to K_ain the DPD for the generalized memory polynomial.

Returns:

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

Return type:

int

set_memory_polynomial_order_type(selector_string, value)[source]

Configures the type of terms of the DPD polynomial when you set the MODEL attribute to Memory Polynomial or Generalized Memory Polynomial.

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

The default value is All Orders.

Name (Value)	Description
All Orders (0)	The memory polynomial will compute all the terms for the given order.
Odd Orders Only (1)	The memory polynomial will compute the non-zero coefficients only for the odd terms.
Even Orders Only (2)	The memory polynomial will compute the non-zero coefficents only for the first linear term and all even terms.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DpdMemoryPolynomialOrderType, int) – Configures the type of terms of the DPD polynomial when you set the MODEL attribute to Memory Polynomial or Generalized Memory Polynomial.

Returns:

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

Return type:

int

set_model(selector_string, value)[source]

Sets the DPD model used by the DPD 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 Lookup Table.

Name (Value)	Description
Lookup Table (0)	This model computes the complex gain coefficients applied when performing digital predistortion to linearize systems with negligible memory effects.
Memory Polynomial (1)	This model computes the memory polynomial predistortion coefficients used to linearize systems with moderate memory effects.
Generalized Memory Polynomial (2)	This model computes the generalized memory polynomial predistortion coefficients used to linearize systems with significant memory effects.
Decomposed Vector Rotation (3)	This model computes the Decomposed Vector Rotation model predistortion coefficients used to linearize wideband systems with significant memory effects.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DpdModel, int) – Specifies the DPD model used by the DPD measurement.

Returns:

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

Return type:

int

set_nmse_enabled(selector_string, value)[source]

Sets whether to enable the normalized mean-squared error (NMSE) computation.

You do not need to use a selector string to configure or read this attribute 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 NMSE computation. NaN is returned as NMSE.
True (1)	Enables NMSE computation.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DpdNmseEnabled, int) – Specifies whether to enable the normalized mean-squared error (NMSE) computation.

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 of the DPD measurement.

The number of threads can range from 1 to the number of physical cores. However, the number of threads you set may not all 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 of the DPD 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_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 DPD Signal Type attribute to Tones, which switches the DPD 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 one or more tones.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DpdSignalType, 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 DPD Signal Type attribute to Tones, which switches the DPD 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 the acquired waveform with 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 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 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 measurement sampling rate is low. Refer to DPD concept help for more information.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DpdSynchronizationMethod, int) – Specifies the method used for synchronization of the acquired waveform with 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_target_gain_type(selector_string, value)[source]

Sets the gain expected from the DUT after applying DPD on the input 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 Average Gain.

Name (Value)	Description
Average Gain (0)	The DPD polynomial or lookup table is computed by assuming that the linearized gain expected from the DUT after applying DPD on the input waveform is equal to the average power gain provided by the DUT without DPD.
Linear Region Gain (1)	The DPD polynomial or lookup table is computed by assuming that the linearized gain expected from the DUT after applying DPD on the input waveform is equal to the gain provided by the DUT, without DPD, to the parts of the reference waveform that do not drive the DUT into non-linear gain-expansion or compression regions of its input-output characteristics. The measurement computes the linear region gain as the average gain experienced by the parts of the reference waveform that are below a threshold which is computed as shown in the following equation: Linear region threshold (dBm) = Max {-25, Min {reference waveform power} + 6, DUT Average Input Power -15}
Peak Input Power Gain (2)	The DPD polynomial or lookup table is computed by assuming that the linearized gain expected from the DUT after applying DPD on the input waveform is equal to the average power gain provided by the DUT, without DPD, to all the samples of the reference waveform for which the magnitude is greater than the peak power in the reference waveform (dBm) - 0.5dB.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.DpdTargetGainType, int) – Specifies the gain expected from the DUT after applying DPD on the input waveform.

Returns:

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

Return type:

int