IdpdConfiguration

Provides methods to configure the Idpd measurement.

class nirfmxspecan.idpd_configuration.IdpdConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the Idpd measurement.

configure_equalizer_coefficients(selector_string, x0, dx, equalizer_coefficients)[source]

Configures the equalizer coefficients for the IDPD 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 always pass 0 to this parameter. Any other values are ignored.

  • dx (float) – This parameter specifies the spacing between the coefficients.

  • equalizer_coefficients (numpy.complex64) – This parameter specifies the coefficients to be used by the equalizer.

Returns:

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

Return type:

int

configure_predistorted_waveform(selector_string, x0, dx, predistorted_waveform, target_gain)[source]

Configures the predistorted waveform for the IDPD 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.

  • predistorted_waveform (numpy.complex64) – This parameter specifies the complex baseband samples, in volts.

  • target_gain (float) – This parameter specifies the target gain when the configured pre-distorted waveform is non-empty. This value is expressed in dB.

Returns:

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

Return type:

int

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

Configures the reference waveform for the IDPD 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.IdpdReferenceWaveformIdleDurationPresent, 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.IdpdSignalType, 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

get_all_traces_enabled(selector_string)[source]

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

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_averaging_count(selector_string)[source]

Gets the number of acquisitions used for averaging when AVERAGING_ENABLED is 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 AVERAGING_ENABLED is 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 IDPD 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 number of acquisitions is 1.

True (1)

the measurement uses Averaging Count for the number of acquisitions over which the measurement is averaged.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.IdpdAveragingEnabled):

Specifies whether to enable averaging for the IDPD 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_dut_average_input_power(selector_string)[source]

Gets the initial (first itertion) average power of the signal at the input port of the device under test.

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

The default value is -20.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the initial (first itertion) average power of the signal at the input port of the device under test.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_equalizer_filter_length(selector_string)[source]

Gets the length of the equalizer filter to be trained.

This attribute is applicable when you set EQUALIZER_MODE to Train.

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

The default value is 101. Valid values are 1 to 4096, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the length of the equalizer filter to be trained.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_equalizer_mode(selector_string)[source]

Gets whether to enable equalization.

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

The default value is OFF.

Name (Value)

Description

Off (0)

Equalization filter is not applied.

Train (1)

Train Equalization filter. The filter length is obtained from the IDPD Equalizer Filter Length attribute.

Hold (2)

The RFmxSpecAn IDPD Configure Equalizer Coefficients method specifies the filter that acts as the equalization filter. This filter is applied prior to calculating the predistorted waveform.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.IdpdEqualizerMode):

Specifies whether to enable equalization.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_evm_enabled(selector_string)[source]

Gets whether to enable EVM 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 EVM computation. NaN is returned for Mean RMS EVM.

True (1)

Enables EVM computation.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.IdpdEvmEnabled):

Specifies whether to enable EVM 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_evm_unit(selector_string)[source]

Gets the units of the EVM results.

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

The default value is Percentage.

Name (Value)

Description

Percentage (0)

EVM is expressed as a percentage.

dB (1)

EVM is expressed in dB.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.IdpdEvmUnit):

Specifies the units of the EVM results.

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

Gets the increase of input power relative to the peak power value of the reference signal. 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 6.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the increase of input power relative to the peak power value of the reference signal. 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_impairment_estimation_start(selector_string)[source]

Gets the start time of the impairment estimation interval relative to the start 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 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the start time of the impairment estimation interval relative to the start 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_impairment_estimation_stop(selector_string)[source]

Gets the stop time of the impairment estimation interval relative to the start 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 0.001.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the stop time of the impairment estimation interval relative to the start 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_enabled(selector_string)[source]

Gets whether to enable IDPD 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 IDPD 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_sample_rate(selector_string)[source]

Gets the acquisition sample rate, in S/s, when you set the MEASUREMENT_SAMPLE_RATE_MODE is User. Users should read back the actual sample rate used by the measurement. 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 120000000.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the acquisition sample rate, in S/s, when you set the MEASUREMENT_SAMPLE_RATE_MODE is User. Users should read back the actual sample rate used by the measurement. 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 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)

Acquisition sample rate is defined by the IDPD Meas Sample Rate (S/s) attribute.

Reference Waveform (1)

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

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

Gets the maximum number of threads used for parallelism for the IDPD measurement.

The number of threads can range from 1 to the number of physical cores. However, the number of threads you set may not be used in calculations. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations.

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

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the maximum number of threads used for parallelism for the IDPD 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_power_linearity_tradeoff(selector_string)[source]

Gets the gain tradeoff factor that sets the gain expected from the DUT after applying IDPD on the input waveform. This value is expressed as a percentage.

The percentages zero corresponds to the gain at maximum linearity, hundred corresponds to the gain at maximum power, and fifty corresponds to the gain at average power output from the DUT.

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

The default value is 50.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the gain tradeoff factor that sets the gain expected from the DUT after applying IDPD on the input waveform. This value is expressed as a percentage.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_reference_waveform_idle_duration_present(selector_string)[source]

Gets whether the reference waveform contains idle duration or dead time.

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

The default value is False.

Name (Value)

Description

False (0)

Reference waveform has no idle duration.

True (1)

Reference waveform contains idle duration.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.IdpdReferenceWaveformIdleDurationPresent):

Specifies whether the reference waveform contains idle duration or dead time.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_signal_type(selector_string)[source]

Gets the type of 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 Modulated.

Name (Value)

Description

Modulated (0)

Specifies the reference waveform is a banded signal like cellular or connectivity standard signals.

Tones (1)

Specifies the reference waveform is a continuous signal comprising of one or more tones.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.IdpdSignalType):

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

Gets the start time of the synchronization estimation interval relative to the start 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 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the start time of the synchronization estimation interval relative to the start 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_synchronization_estimation_stop(selector_string)[source]

Gets the stop time of the synchronization estimation interval relative to the start 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 0.001.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the stop time of the synchronization estimation interval relative to the start 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_target_gain(selector_string)[source]

Gets the Target gain when the configured pre-distorted waveform is non-empty.

When the configured pre-distorted waveform is empty, this attribute is ignored. It is recommended to use the Gain result from the previous iteration to configure this attribute.

The default value is 20.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the Target gain when the configured pre-distorted waveform is non-empty.

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

Returns:

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

Return type:

int

set_averaging_count(selector_string, value)[source]

Sets the number of acquisitions used for averaging when AVERAGING_ENABLED is 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 AVERAGING_ENABLED is 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 IDPD 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 number of acquisitions is 1.

True (1)

the measurement uses Averaging Count for the number of acquisitions over which the measurement is averaged.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.IdpdAveragingEnabled, int) – Specifies whether to enable averaging for the IDPD measurement.

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 initial (first itertion) average power of the signal at the input port of the device under test.

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

The default value is -20.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the initial (first itertion) average power of the signal at the input port of the device under test.

Returns:

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

Return type:

int

set_equalizer_filter_length(selector_string, value)[source]

Sets the length of the equalizer filter to be trained.

This attribute is applicable when you set EQUALIZER_MODE to Train.

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

The default value is 101. Valid values are 1 to 4096, inclusive.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the length of the equalizer filter to be trained.

Returns:

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

Return type:

int

set_equalizer_mode(selector_string, value)[source]

Sets whether to enable equalization.

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

The default value is OFF.

Name (Value)

Description

Off (0)

Equalization filter is not applied.

Train (1)

Train Equalization filter. The filter length is obtained from the IDPD Equalizer Filter Length attribute.

Hold (2)

The RFmxSpecAn IDPD Configure Equalizer Coefficients method specifies the filter that acts as the equalization filter. This filter is applied prior to calculating the predistorted waveform.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.IdpdEqualizerMode, int) – Specifies whether to enable equalization.

Returns:

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

Return type:

int

set_evm_enabled(selector_string, value)[source]

Sets whether to enable EVM 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 EVM computation. NaN is returned for Mean RMS EVM.

True (1)

Enables EVM computation.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.IdpdEvmEnabled, int) – Specifies whether to enable EVM computation.

Returns:

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

Return type:

int

set_evm_unit(selector_string, value)[source]

Sets the units of the EVM results.

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

The default value is Percentage.

Name (Value)

Description

Percentage (0)

EVM is expressed as a percentage.

dB (1)

EVM is expressed in dB.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.IdpdEvmUnit, int) – Specifies the units of the EVM results.

Returns:

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

Return type:

int

set_gain_expansion(selector_string, value)[source]

Sets the increase of input power relative to the peak power value of the reference signal. 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 6.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the increase of input power relative to the peak power value of the reference signal. 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_impairment_estimation_start(selector_string, value)[source]

Sets the start time of the impairment estimation interval relative to the start 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 0.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the start time of the impairment estimation interval relative to the start 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_impairment_estimation_stop(selector_string, value)[source]

Sets the stop time of the impairment estimation interval relative to the start 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 0.001.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the stop time of the impairment estimation interval relative to the start 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_enabled(selector_string, value)[source]

Sets whether to enable IDPD 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 IDPD 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_sample_rate(selector_string, value)[source]

Sets the acquisition sample rate, in S/s, when you set the MEASUREMENT_SAMPLE_RATE_MODE is User. Users should read back the actual sample rate used by the measurement. 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 120000000.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the acquisition sample rate, in S/s, when you set the MEASUREMENT_SAMPLE_RATE_MODE is User. Users should read back the actual sample rate used by the measurement. 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 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)

Acquisition sample rate is defined by the IDPD Meas Sample Rate (S/s) attribute.

Reference Waveform (1)

Acquisition sample rate is set to match the sample rate of the reference 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_numberof_analysis_threads(selector_string, value)[source]

Sets the maximum number of threads used for parallelism for the IDPD measurement.

The number of threads can range from 1 to the number of physical cores. However, the number of threads you set may not be used in calculations. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations.

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

The default value is 1.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the maximum number of threads used for parallelism for the IDPD measurement.

Returns:

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

Return type:

int

set_power_linearity_tradeoff(selector_string, value)[source]

Sets the gain tradeoff factor that sets the gain expected from the DUT after applying IDPD on the input waveform. This value is expressed as a percentage.

The percentages zero corresponds to the gain at maximum linearity, hundred corresponds to the gain at maximum power, and fifty corresponds to the gain at average power output from the DUT.

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

The default value is 50.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the gain tradeoff factor that sets the gain expected from the DUT after applying IDPD on the input waveform. This value is expressed as a percentage.

Returns:

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

Return type:

int

set_reference_waveform_idle_duration_present(selector_string, value)[source]

Sets whether the reference waveform contains idle duration or dead time.

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

The default value is False.

Name (Value)

Description

False (0)

Reference waveform has no idle duration.

True (1)

Reference waveform contains idle duration.
Parameters:
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 the type of 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 Modulated.

Name (Value)

Description

Modulated (0)

Specifies the reference waveform is a banded signal like cellular or connectivity standard signals.

Tones (1)

Specifies the reference waveform is a continuous signal comprising of one or more tones.
Parameters:

  • selector_string (string) – Pass an empty string.

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

Sets the start time of the synchronization estimation interval relative to the start 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 0.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the start time of the synchronization estimation interval relative to the start 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_synchronization_estimation_stop(selector_string, value)[source]

Sets the stop time of the synchronization estimation interval relative to the start 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 0.001.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the stop time of the synchronization estimation interval relative to the start 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_target_gain(selector_string, value)[source]

Sets the Target gain when the configured pre-distorted waveform is non-empty.

When the configured pre-distorted waveform is empty, this attribute is ignored. It is recommended to use the Gain result from the previous iteration to configure this attribute.

The default value is 20.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the Target gain when the configured pre-distorted waveform is non-empty.

Returns:

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

Return type:

int