IdpdResults

Provides methods to fetch and read the Idpd measurement results.

class nirfmxspecan.idpd_results.IdpdResults(signal_obj)

Bases: object

Provides methods to fetch and read the Idpd measurement results.

fetch_equalizer_coefficients(selector_string, timeout, equalizer_coefficients)

Fetches the trained equalizer coefficients.

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.

• equalizer_coefficients (numpy.complex64) – This parameter returns the updated equalizer coefficients.

Returns:

x0 (float):

This parameter this parameter always returns 0.

dx (float):

This parameter returns the spacing between the coefficients.

error_code (int):

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

Return type:

Tuple (x0, dx, error_code)

fetch_predistorted_waveform(selector_string, timeout, predistorted_waveform)

Fetches the predistorted waveform output after the IDPD measurement.

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.

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

Returns:

x0 (float):

This parameter returns the start time, in seconds.

dx (float):

This parameter returns the sample duration, in seconds.

papr (float):

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

power_offset (float):

This parameter returns the change in the average power in the waveform due to applying digital predistortion. This value is expressed in dB.

gain (float):

This parameter returns the gain of the device under test. 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 (x0, dx, papr, power_offset, gain, error_code)

fetch_processed_mean_acquired_waveform(selector_string, timeout, processed_mean_acquired_waveform)

Fetches the averaged acquired waveform, corrected for frequency, phase, and DC offsets, used to perform the IDPD measurement.

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.

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

Returns:

x0 (float):

This parameter returns the start time, in seconds.

dx (float):

This parameter returns the sample duration, 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 (x0, dx, error_code)

fetch_processed_reference_waveform(selector_string, timeout, processed_reference_waveform)

Fetches the reference waveform used to perform the IDPD measurement.

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.

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

Returns:

x0 (float):

This parameter returns the start time, in seconds.

dx (float):

This parameter returns the sample duration, 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 (x0, dx, error_code)

get_equalizer_reference_waveform(selector_string, equalizer_reference_waveform)

Gets the equalizer reference waveform used to perform the IDPD measurement.

Parameters:

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

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

Returns:

x0 (float):

This parameter returns the start time, in seconds.

dx (float):

This parameter returns the sample duration, in seconds.

papr (float):

This parameter returns the peak-to-average power ratio of the waveform obtained after applying digital predistortion. 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 (x0, dx, papr, error_code)

get_gain(selector_string)

Gets the gain of the device under test. 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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the gain of the device under test. 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_mean_rms_evm(selector_string)

Gets the ratio of L2 norm of difference between the normalized reference and acquired waveforms, to the L2 norm of the normalized reference waveform. This value is expressed either as a percentage or in dB depending on the configured EVM_UNIT,

You do not need to use a selector string to configure 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):

Returns the ratio of L2 norm of difference between the normalized reference and acquired waveforms, to the L2 norm of the normalized reference waveform. This value is expressed either as a percentage or in dB depending on the configured EVM_UNIT,

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)