DpdApplyDpd

class nirfmxspecan.dpd_apply_dpd.DpdApplyDpd(signal_obj)[source]

Bases: object

apply_digital_predistortion(selector_string, x0_in, dx_in, waveform_in, idle_duration_present, measurement_timeout, waveform_out)[source]

Scales the input waveform to DUT average input power and then predistorts using the DPD polynomial or the lookup table. To scale the waveform correctly, specify if the idle duration is present in the waveform.

Parameters:

  • selector_string (string) – Specifies the result name. Example: “”, “result::r1”. You can use the build_result_string method to build the selector string.

  • x0_in (float) – Specifies the start time, in seconds.

  • dx_in (float) – Specifies the sample duration, in seconds.

  • waveform_in (numpy.complex64) – Specifies the complex baseband equivalent of the RF signal on which to apply digital predistortion.

  • idle_duration_present (enums.DpdApplyDpdIdleDurationPresent, int) – Specifies whether the waveform contains an idle duration.

  • measurement_timeout (float) – Specifies the timeout, in seconds, for fetching the specified measurement.

  • waveform_out (numpy.complex64) – Upon return, contains the complex baseband equivalent of the RF signal on which to apply digital predistortion.

Returns:

x0_out (float):

Contains the start time, in seconds.

dx_out (float):

Contains the sample duration, in seconds.

papr (float):

Contains the peak-to-average power ratio of the waveform obtained after applying digital predistortion. This value is expressed in dB.

power_offset (float):

Contains the change in the average power in the waveform due to applying digital predistion. 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 (float, float, float, float, int)

configure_configuration_input(selector_string, configuration_input)[source]

Configures the source of measurement settings for applying DPD.

Parameters:

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

  • configuration_input (enums.DpdApplyDpdConfigurationInput, int) –

    This parameter specifies the mode of configuring parameters for applying DPD. The default value is Measurement.

    Name (Value)

    Description

    Measurement (0)

    Uses the computed DPD polynomial or lookup table for applying DPD on an input waveform using the same RFmx session handle. The configuration parameters for applying DPD such as the DPD DUT Avg Input Pwr, DPD Model, DPD Meas Sample Rate, DPD polynomial, and lookup table are obtained from the DPD measurement configuration.

    User (1)

    Applies DPD by using a computed DPD polynomial or lookup table on an input waveform. You must set the configuration parameters for applying DPD such as the DPD Apply DPD User DUT Avg Input Pwr, DPD Apply DPD User DPD Model, DPD Apply DPD User Meas Sample Rate, DPD polynomial, and lookup table.

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_correction_type(selector_string, lut_correction_type)[source]

Configures the predistortion type 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.

  • lut_correction_type (enums.DpdApplyDpdLookupTableCorrectionType, int) –

    This parameter specifies the predistortion type when you set the MODEL attribute to Lookup Table. The default value is Magnitude and Phase.

    Name (Value)

    Description

    Magnitude and Phase (0)

    The measurement predistorts the magnitude and phase of the input waveform.

    Magnitude Only (1)

    The measurement predistorts only the magnitude of the input waveform.

    Phase Only (2)

    The measurement predistorts only the phase of 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

configure_memory_model_correction_type(selector_string, memory_model_correction_type)[source]

Configures the predistortion type when you set the MODEL property 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_model_correction_type (enums.DpdApplyDpdMemoryModelCorrectionType, int) –

    This parameter specifies the predistortion type when you set the DPD Model attribute to Memory Polynomial or Generalized Memory Polynomial. The default value is Magnitude and Phase.

    Name (Value)

    Description

    Magnitude and Phase (0)

    The measurement predistorts the magnitude and phase of the input waveform.

    Magnitude Only (1)

    The measurement predistorts only the magnitude of the input waveform.

    Phase Only (2)

    The measurement predistorts only the phase of 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

configure_user_dpd_polynomial(selector_string, dpd_polynomial)[source]

Configures the array of memory polynomial or generalized memory polynomial coefficients 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.

  • dpd_polynomial (numpy.complex64) – This parameter specifies the array of memory polynomial or generalized memory polynomial coefficients when you set the DPD 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

configure_user_lookup_table(selector_string, lut_input_powers, lut_complex_gains)[source]

Configures the predistortion lookup table when you set the MODEL property to ** Lookup Table ** .

Parameters:

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

  • lut_input_powers (float) – This parameter specifies the array of lookup table power levels, in dBm.

  • lut_complex_gains (numpy.complex64) – This parameter specifies the array of lookup table complex gain values for magnitude and phase predistortion.

Returns:

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

Return type:

int

fetch_pre_cfr_papr(selector_string, timeout)[source]

Fetches the PAPR of the pre-distorted waveform before CFR is applied to it.

Parameters:

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

  • timeout (float) – This parameter specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

pre_cfr_papr (float):

This parameter returns the PAPR of the pre-distorted waveform before CFR is applied when you set the CFR_ENABLED attribute to True. This value is expressed in dB.

When you set the DPD Apply DPD CFR Enabled attribute to False and the MODEL attribute to Lookup Table, the PAPR of the pre-distorted waveform is returned.

When you set the DPD Apply DPD CFR Enabled attribute to False and the DPD Model attribute to Memory Polynomial or Generalized Memory Polynomial, the PAPR of the clipped pre-distorted waveform is returned. The pre-distorted waveform is clipped such that its peak amplitude does not exceed the peak of the input waveform, scaled to DUT average input power, by 6 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 (pre_cfr_papr, error_code)

get_apply_dpd_user_lookup_table_type(selector_string)[source]

Gets the DPD Lookup Table (LUT) type when you set the CONFIGURATION_INPUT attribute to 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.

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

Specifies the DPD Lookup Table (LUT) type when you set the CONFIGURATION_INPUT attribute to 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_cfr_enabled(selector_string)[source]

Gets whether to enable the crest factor reduction (CFR) on the pre-distorted 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 False.

Name (Value)

Description

False (0)

Disables CFR. The maximum increase in PAPR, after pre-distortion, is limited to 6 dB.

True (1)

Enables CFR.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DpdApplyDpdCfrEnabled):

Specifies whether to enable the crest factor reduction (CFR) on the pre-distorted 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_cfr_maximum_iterations(selector_string)[source]

Gets the maximum number of iterations allowed to converge waveform PAPR to target PAPR when you set the CFR_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 maximum number of iterations allowed to converge waveform PAPR to target PAPR when you set the CFR_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_cfr_method(selector_string)[source]

Gets the method used to perform the crest factor reduction (CFR) when you set the CFR_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 Clipping.

Name (Value)

Description

Clipping (0)

Hard clips the signal such that the target PAPR is achieved.

Peak Windowing (1)

Scales the peaks in the signal using weighted window function to get smooth peaks and achieve the target PAPR.

Sigmoid (2)

Scales the peaks using modified sigmoid transfer function to get smooth peaks and achieve the target PAPR. This method does not support the filter operation.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DpdApplyDpdCfrMethod):

Specifies the method used to perform the crest factor reduction (CFR) when you set the CFR_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_cfr_shaping_factor(selector_string)[source]

Gets the shaping factor to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Sigmoid. Refer to DPD concept topic for more information about shaping factor.

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

The default value is 5.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the shaping factor to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Sigmoid. Refer to DPD concept topic for more information about shaping factor.

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

Gets the shaping threshold to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Sigmoid. This value is expressed in dB. Refer to DPD concept topic for more information about shaping threshold.

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

The default value is -5.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the shaping threshold to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Sigmoid. This value is expressed in dB. Refer to DPD concept topic for more information about shaping threshold.

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

Gets the target PAPR when you set the CFR_ENABLED attribute to True and the CFR_TARGET_PAPR_TYPE attribute to Custom. 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 8.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the target PAPR when you set the CFR_ENABLED attribute to True and the CFR_TARGET_PAPR_TYPE attribute to Custom. 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_cfr_target_papr_type(selector_string)[source]

Gets the target PAPR type when you set the CFR_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 Input PAPR.

Name (Value)

Description

Input PAPR (0)

Sets the target PAPR for pre-distorted waveform equal to the PAPR of input waveform.

Custom (1)

Sets the target PAPR equal to the value that you set for the Apply DPD CFR Target PAPR attribute.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DpdApplyDpdCfrTargetPaprType):

Specifies the target PAPR type when you set the CFR_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_cfr_window_length(selector_string)[source]

Gets the maximum window length to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Peak Windowing.

You do not need to use a selector string to configure or read this attribute 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 maximum window length to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Peak Windowing.

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

Gets the window type to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Peak Windowing.

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

The default value is Kaiser-Bessel.

Name (Value)

Description

Flat Top (1)

Uses the flat top window function to scale peaks.

Hanning (2)

Uses the Hanning window function to scale peaks.

Hamming (3)

Uses the Hamming window function to scale peaks.

Gaussian (4)

Uses the Gaussian window function to scale peaks.

Blackman (5)

Uses the Blackman window function to scale peaks.

Blackman-Harris (6)

Uses the Blackman-Harris window function to scale peaks.

Kaiser-Bessel (7)

Uses the Kaiser-Bessel window function to scale peaks.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DpdApplyDpdCfrWindowType):

Specifies the window type to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Peak Windowing.

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

Gets whether to use the configuration parameters used by the DPD measurement for applying 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 Measurement.

Name (Value)

Description

Measurement (0)

Uses the computed DPD polynomial or lookup table for applying DPD on an input waveform using the same RFmx session handle. The configuration parameters for applying DPD such as the DPD DUT Avg Input Pwr, DPD Model, DPD Meas Sample Rate, DPD polynomial, and lookup table are obtained from the DPD measurement configuration.

User (1)

Applies DPD by using a computed DPD polynomial or lookup table on an input waveform. You must set the configuration parameters for applying DPD such as the DPD Apply DPD User DUT Avg Input Pwr, DPD Apply DPD User DPD Model, DPD Apply DPD User Meas Sample Rate, DPD polynomial, and lookup table. You do not need to call the RFmxSpecAn Initiate method when you set the DPD Apply DPD Config Input attribute User.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DpdApplyDpdConfigurationInput):

Specifies whether to use the configuration parameters used by the DPD measurement for applying 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_correction_type(selector_string)[source]

Gets the predistortion type 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 Magnitude and Phase.

Name (Value)

Description

Magnitude and Phase (0)

The measurement predistorts the magnitude and phase of the input waveform.

Magnitude Only (1)

The measurement predistorts only the magnitude of the input waveform.

Phase Only (2)

The measurement predistorts only the phase of the input waveform.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DpdApplyDpdLookupTableCorrectionType):

Specifies the predistortion type 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_memory_model_correction_type(selector_string)[source]

Gets the predistortion type 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 Magnitude and Phase.

Name (Value)

Description

Magnitude and Phase (0)

The measurement predistorts the magnitude and phase of the input waveform.

Magnitude Only (1)

The measurement predistorts only the magnitude of the input waveform.

Phase Only (2)

The measurement predistorts only the phase of the input waveform.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DpdApplyDpdMemoryModelCorrectionType):

Specifies the predistortion type 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_user_dpd_model(selector_string)[source]

Gets the DPD model for applying DPD when you set the CONFIGURATION_INPUT attribute to 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 Lookup Table.

Name (Value)

Description

Lookup Table (0)

This model computes the complex gain coefficients applied 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.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DpdApplyDpdUserDpdModel):

Specifies the DPD model for applying DPD when you set the CONFIGURATION_INPUT attribute to 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_user_dut_average_input_power(selector_string)[source]

Gets the average input power for the device under test that was used to compute the DPD Apply DPD User DPD Polynomial or the DPD Apply DPD User LUT Complex Gain when you set the CONFIGURATION_INPUT attribute to User. 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 input power for the device under test that was used to compute the DPD Apply DPD User DPD Polynomial or the DPD Apply DPD User LUT Complex Gain when you set the CONFIGURATION_INPUT attribute to User. 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_user_lookup_table_input_power(selector_string)[source]

Gets the input power array for the predistortion lookup table when you set the USER_DPD_MODEL attribute to Lookup Table. 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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the input power array for the predistortion lookup table when you set the USER_DPD_MODEL attribute to Lookup Table. 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_user_measurement_sample_rate(selector_string)[source]

Gets the acquisition sample rate used to compute the DPD Apply DPD User DPD Polynomial or DPD Apply DPD User LUT Complex Gain when you set the CONFIGURATION_INPUT attribute to User. This value is expressed in Hz. 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 used to compute the DPD Apply DPD User DPD Polynomial or DPD Apply DPD User LUT Complex Gain when you set the CONFIGURATION_INPUT attribute to User. This value is expressed in Hz. 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_user_memory_polynomial_lag_memory_depth(selector_string)[source]

Gets the lag memory depth cross term of the DPD polynomial when you set the USER_DPD_MODEL attribute to Memory Polynomial or Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Qbin 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 USER_DPD_MODEL attribute to Memory Polynomial or Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Qbin 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_user_memory_polynomial_lag_order(selector_string)[source]

Gets the lag order cross term of the DPD polynomial when you set the USER_DPD_MODEL attribute to Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Kbin 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 USER_DPD_MODEL attribute to Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Kbin 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_user_memory_polynomial_lead_memory_depth(selector_string)[source]

Gets the lead memory depth cross term of the DPD polynomial when you set the USER_DPD_MODEL attribute to Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Qcin the DPD for the generalized memory polynomial. The value of the DPD Apply DPD User Mem Poly Lead Mem Depth attribute must be greater than or equal to the value of the USER_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 USER_DPD_MODEL attribute to Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Qcin the DPD for the generalized memory polynomial. The value of the DPD Apply DPD User Mem Poly Lead Mem Depth attribute must be greater than or equal to the value of the USER_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_user_memory_polynomial_lead_order(selector_string)[source]

Gets the lead order cross term of the DPD polynomial when you set the USER_DPD_MODEL attribute to Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Kcin 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 USER_DPD_MODEL attribute to Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Kcin 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_user_memory_polynomial_maximum_lag(selector_string)[source]

Gets the maximum lag stagger cross term of the DPD polynomial when you set the USER_DPD_MODEL attribute to Memory Polynomial or Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Mbin 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 USER_DPD_MODEL attribute to Memory Polynomial or Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Mbin 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_user_memory_polynomial_maximum_lead(selector_string)[source]

Gets the maximum lead stagger cross term of the DPD polynomial when you set the USER_DPD_MODEL attribute to Memory Polynomial or Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Mcin 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 USER_DPD_MODEL attribute to Memory Polynomial or Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Mcin 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_user_memory_polynomial_memory_depth(selector_string)[source]

Gets the memory depth of the DPD polynomial when you set the USER_DPD_MODEL attribute to Memory Polynomial or Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Qain the DPD for 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 USER_DPD_MODEL attribute to Memory Polynomial or Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Qain the DPD for 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_user_memory_polynomial_order(selector_string)[source]

Gets the order of the DPD polynomial when you set the USER_DPD_MODEL attribute to Memory Polynomial or Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Kain the DPD for 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 USER_DPD_MODEL attribute to Memory Polynomial or Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Kain the DPD for 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)

set_apply_dpd_user_lookup_table_type(selector_string, value)[source]

Sets the DPD Lookup Table (LUT) type when you set the CONFIGURATION_INPUT attribute to 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.

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.DpdApplyDpdUserLookupTableType, int) – Specifies the DPD Lookup Table (LUT) type when you set the CONFIGURATION_INPUT attribute to User.

Returns:

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

Return type:

int

set_cfr_enabled(selector_string, value)[source]

Sets whether to enable the crest factor reduction (CFR) on the pre-distorted 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 False.

Name (Value)

Description

False (0)

Disables CFR. The maximum increase in PAPR, after pre-distortion, is limited to 6 dB.

True (1)

Enables CFR.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.DpdApplyDpdCfrEnabled, int) – Specifies whether to enable the crest factor reduction (CFR) on the pre-distorted waveform.

Returns:

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

Return type:

int

set_cfr_maximum_iterations(selector_string, value)[source]

Sets the maximum number of iterations allowed to converge waveform PAPR to target PAPR when you set the CFR_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 maximum number of iterations allowed to converge waveform PAPR to target PAPR when you set the CFR_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_cfr_method(selector_string, value)[source]

Sets the method used to perform the crest factor reduction (CFR) when you set the CFR_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 Clipping.

Name (Value)

Description

Clipping (0)

Hard clips the signal such that the target PAPR is achieved.

Peak Windowing (1)

Scales the peaks in the signal using weighted window function to get smooth peaks and achieve the target PAPR.

Sigmoid (2)

Scales the peaks using modified sigmoid transfer function to get smooth peaks and achieve the target PAPR. This method does not support the filter operation.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.DpdApplyDpdCfrMethod, int) – Specifies the method used to perform the crest factor reduction (CFR) when you set the CFR_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_cfr_shaping_factor(selector_string, value)[source]

Sets the shaping factor to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Sigmoid. Refer to DPD concept topic for more information about shaping factor.

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

The default value is 5.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the shaping factor to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Sigmoid. Refer to DPD concept topic for more information about shaping factor.

Returns:

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

Return type:

int

set_cfr_shaping_threshold(selector_string, value)[source]

Sets the shaping threshold to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Sigmoid. This value is expressed in dB. Refer to DPD concept topic for more information about shaping threshold.

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

The default value is -5.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the shaping threshold to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Sigmoid. This value is expressed in dB. Refer to DPD concept topic for more information about shaping threshold.

Returns:

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

Return type:

int

set_cfr_target_papr(selector_string, value)[source]

Sets the target PAPR when you set the CFR_ENABLED attribute to True and the CFR_TARGET_PAPR_TYPE attribute to Custom. 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 8.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the target PAPR when you set the CFR_ENABLED attribute to True and the CFR_TARGET_PAPR_TYPE attribute to Custom. 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_cfr_target_papr_type(selector_string, value)[source]

Sets the target PAPR type when you set the CFR_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 Input PAPR.

Name (Value)

Description

Input PAPR (0)

Sets the target PAPR for pre-distorted waveform equal to the PAPR of input waveform.

Custom (1)

Sets the target PAPR equal to the value that you set for the Apply DPD CFR Target PAPR attribute.
Parameters:
Returns:

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

Return type:

int

set_cfr_window_length(selector_string, value)[source]

Sets the maximum window length to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Peak Windowing.

You do not need to use a selector string to configure or read this attribute 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 maximum window length to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Peak Windowing.

Returns:

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

Return type:

int

set_cfr_window_type(selector_string, value)[source]

Sets the window type to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Peak Windowing.

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

The default value is Kaiser-Bessel.

Name (Value)

Description

Flat Top (1)

Uses the flat top window function to scale peaks.

Hanning (2)

Uses the Hanning window function to scale peaks.

Hamming (3)

Uses the Hamming window function to scale peaks.

Gaussian (4)

Uses the Gaussian window function to scale peaks.

Blackman (5)

Uses the Blackman window function to scale peaks.

Blackman-Harris (6)

Uses the Blackman-Harris window function to scale peaks.

Kaiser-Bessel (7)

Uses the Kaiser-Bessel window function to scale peaks.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.DpdApplyDpdCfrWindowType, int) – Specifies the window type to be used when you set the CFR_ENABLED attribute to True and the CFR_METHOD attribute to Peak Windowing.

Returns:

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

Return type:

int

set_configuration_input(selector_string, value)[source]

Sets whether to use the configuration parameters used by the DPD measurement for applying 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 Measurement.

Name (Value)

Description

Measurement (0)

Uses the computed DPD polynomial or lookup table for applying DPD on an input waveform using the same RFmx session handle. The configuration parameters for applying DPD such as the DPD DUT Avg Input Pwr, DPD Model, DPD Meas Sample Rate, DPD polynomial, and lookup table are obtained from the DPD measurement configuration.

User (1)

Applies DPD by using a computed DPD polynomial or lookup table on an input waveform. You must set the configuration parameters for applying DPD such as the DPD Apply DPD User DUT Avg Input Pwr, DPD Apply DPD User DPD Model, DPD Apply DPD User Meas Sample Rate, DPD polynomial, and lookup table. You do not need to call the RFmxSpecAn Initiate method when you set the DPD Apply DPD Config Input attribute User.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.DpdApplyDpdConfigurationInput, int) – Specifies whether to use the configuration parameters used by the DPD measurement for applying 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_correction_type(selector_string, value)[source]

Sets the predistortion type 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 Magnitude and Phase.

Name (Value)

Description

Magnitude and Phase (0)

The measurement predistorts the magnitude and phase of the input waveform.

Magnitude Only (1)

The measurement predistorts only the magnitude of the input waveform.

Phase Only (2)

The measurement predistorts only the phase of the input waveform.
Parameters:
Returns:

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

Return type:

int

set_memory_model_correction_type(selector_string, value)[source]

Sets the predistortion type 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 Magnitude and Phase.

Name (Value)

Description

Magnitude and Phase (0)

The measurement predistorts the magnitude and phase of the input waveform.

Magnitude Only (1)

The measurement predistorts only the magnitude of the input waveform.

Phase Only (2)

The measurement predistorts only the phase of the input waveform.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.DpdApplyDpdMemoryModelCorrectionType, int) – Specifies the predistortion type 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_user_dpd_model(selector_string, value)[source]

Sets the DPD model for applying DPD when you set the CONFIGURATION_INPUT attribute to 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 Lookup Table.

Name (Value)

Description

Lookup Table (0)

This model computes the complex gain coefficients applied 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.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.DpdApplyDpdUserDpdModel, int) – Specifies the DPD model for applying DPD when you set the CONFIGURATION_INPUT attribute to User.

Returns:

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

Return type:

int

set_user_dut_average_input_power(selector_string, value)[source]

Sets the average input power for the device under test that was used to compute the DPD Apply DPD User DPD Polynomial or the DPD Apply DPD User LUT Complex Gain when you set the CONFIGURATION_INPUT attribute to User. 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 input power for the device under test that was used to compute the DPD Apply DPD User DPD Polynomial or the DPD Apply DPD User LUT Complex Gain when you set the CONFIGURATION_INPUT attribute to User. 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_user_lookup_table_input_power(selector_string, value)[source]

Sets the input power array for the predistortion lookup table when you set the USER_DPD_MODEL attribute to Lookup Table. 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.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the input power array for the predistortion lookup table when you set the USER_DPD_MODEL attribute to Lookup Table. 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_user_measurement_sample_rate(selector_string, value)[source]

Sets the acquisition sample rate used to compute the DPD Apply DPD User DPD Polynomial or DPD Apply DPD User LUT Complex Gain when you set the CONFIGURATION_INPUT attribute to User. This value is expressed in Hz. 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 used to compute the DPD Apply DPD User DPD Polynomial or DPD Apply DPD User LUT Complex Gain when you set the CONFIGURATION_INPUT attribute to User. This value is expressed in Hz. 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_user_memory_polynomial_lag_memory_depth(selector_string, value)[source]

Sets the lag memory depth cross term of the DPD polynomial when you set the USER_DPD_MODEL attribute to Memory Polynomial or Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Qbin 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 USER_DPD_MODEL attribute to Memory Polynomial or Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Qbin 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_user_memory_polynomial_lag_order(selector_string, value)[source]

Sets the lag order cross term of the DPD polynomial when you set the USER_DPD_MODEL attribute to Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Kbin 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 USER_DPD_MODEL attribute to Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Kbin 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_user_memory_polynomial_lead_memory_depth(selector_string, value)[source]

Sets the lead memory depth cross term of the DPD polynomial when you set the USER_DPD_MODEL attribute to Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Qcin the DPD for the generalized memory polynomial. The value of the DPD Apply DPD User Mem Poly Lead Mem Depth attribute must be greater than or equal to the value of the USER_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 USER_DPD_MODEL attribute to Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Qcin the DPD for the generalized memory polynomial. The value of the DPD Apply DPD User Mem Poly Lead Mem Depth attribute must be greater than or equal to the value of the USER_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_user_memory_polynomial_lead_order(selector_string, value)[source]

Sets the lead order cross term of the DPD polynomial when you set the USER_DPD_MODEL attribute to Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Kcin 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 USER_DPD_MODEL attribute to Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Kcin 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_user_memory_polynomial_maximum_lag(selector_string, value)[source]

Sets the maximum lag stagger cross term of the DPD polynomial when you set the USER_DPD_MODEL attribute to Memory Polynomial or Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Mbin 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 USER_DPD_MODEL attribute to Memory Polynomial or Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Mbin 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_user_memory_polynomial_maximum_lead(selector_string, value)[source]

Sets the maximum lead stagger cross term of the DPD polynomial when you set the USER_DPD_MODEL attribute to Memory Polynomial or Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Mcin 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 USER_DPD_MODEL attribute to Memory Polynomial or Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Mcin 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_user_memory_polynomial_memory_depth(selector_string, value)[source]

Sets the memory depth of the DPD polynomial when you set the USER_DPD_MODEL attribute to Memory Polynomial or Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Qain the DPD for 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 USER_DPD_MODEL attribute to Memory Polynomial or Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Qain the DPD for 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_user_memory_polynomial_order(selector_string, value)[source]

Sets the order of the DPD polynomial when you set the USER_DPD_MODEL attribute to Memory Polynomial or Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Kain the DPD for 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 USER_DPD_MODEL attribute to Memory Polynomial or Generalized Memory Polynomial and set the CONFIGURATION_INPUT attribute to User. This value corresponds to Kain the DPD for 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