DpdResults

Provides methods to fetch and read the Dpd measurement results.

class nirfmxspecan.dpd_results.DpdResults(signal_obj)

Bases: object

Provides methods to fetch and read the Dpd measurement results.

fetch_average_gain(selector_string, timeout)

Fetches the average gain, in dB, of the device under test (DUT) for the DPD measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the selector string.

• 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:

average_gain (float):

This parameter returns the average gain, in dB, of the DUT.

error_code (int):

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

Return type:

Tuple (average_gain, error_code)

fetch_dpd_polynomial(selector_string, timeout, dpd_polynomial)

Fetches the memory polynomial or generalized memory polynomial coefficients when you set the MODEL attribute to Memory Polynomial or Generalized Memory Polynomial.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the selector string.

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

• dpd_polynomial (numpy.complex64) – This parameter returns the 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

fetch_dvr_model(selector_string, timeout, dvr_model)

Fetches the decomposed vector rotation model coefficients when you set the MODEL attribute to Decomposed Vector Rotation.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the selector string.

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

• dvr_model (numpy.complex64) – This parameter returns the decomposed vector rotation model coefficients when you set the DPD Model attribute to Decomposed Vector Rotation.

Returns:

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

Return type:

int

fetch_lookup_table(selector_string, timeout, complex_gains)

Fetches the predistortion lookup table when MODEL property to ** Lookup Table ** .

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the selector string.

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

• complex_gains (numpy.complex64) – This parameter returns the lookup table complex gain values, in dB, for magnitude and phase predistortion.

Returns:

input_powers (float):

This parameter returns the lookup table power levels, 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 (input_powers, error_code)

fetch_nmse(selector_string, timeout)

Fetches the normalized mean-squared DPD modeling error.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the selector string.

• 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:

nmse (float):

This parameter returns the normalized mean-squared DPD modeling error when you set the NMSE_ENABLED attribute to True. 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 (nmse, 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 DPD measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the selector string.

• 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 segment of the reference waveform used to perform the DPD measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ””

  ”result::r1”

  You can use the build_result_string() method to build the selector string.

• 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_average_gain(selector_string)

Gets the average gain of the device under test. This value is expressed in dB.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the average 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_nmse(selector_string)

Gets the normalized mean-squared DPD modeling error when you set the NMSE_ENABLED attribute to True. This value is expressed in dB. NaN is returned when the NMSE_ENABLED attribute is set to False.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the normalized mean-squared DPD modeling error when you set the NMSE_ENABLED attribute to True. This value is expressed in dB. NaN is returned when the NMSE_ENABLED attribute is set to False.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)