QevmResults

Provides methods to fetch and read the Qevm measurement results.

class nirfmxcdma2k.qevm_results.QevmResults(signal_obj)

Bases: object

Provides methods to fetch and read the Qevm measurement results.

fetch_constellation_trace(selector_string, timeout, constellation)

Returns the complex chips of the corrected received signal for the QEVM measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name. Examples:

  ””

  ”signal::sig1”

  ”result::r1”

  ”signal::sig1/result::r1”

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

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. This value is expressed in seconds. 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.

• constellation (numpy.complex64) – This parameter returns the array of complex chips of the corrected signal on which the QEVM measurements are performed. You can use these chips to obtain the constellation diagram.

Returns:

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

Return type:

int

fetch_evm(selector_string, timeout)

Returns the EVM value and related measurement values of the QEVM measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name. Examples:

  ””

  ”signal::sig1”

  ”result::r1”

  ”signal::sig1/result::r1”

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

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. This value is expressed in seconds. 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:

mean_rms_evm (float):

This parameter returns the mean averaged RMS EVM of the received signal. This value is expressed as a percentage.

maximum_peak_evm (float):

This parameter returns the maximum peak EVM of the received signal. This value is expressed as a percentage.

mean_frequency_error (float):

This parameter returns the mean averaged frequency error of the received signal. This value is expressed in Hz.

mean_magnitude_error (float):

This parameter returns the mean averaged phase error of the received signal. This value is expressed in degrees.

mean_phase_error (float):

This parameter returns the mean averaged magnitude error of the received signal. This value is expressed as a percentage.

mean_chip_rate_error (float):

This parameter returns the measured mean chip rate error of the received signal. This value is expressed in parts per million (ppm).

error_code (int):

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

Return type:

Tuple (mean_rms_evm, maximum_peak_evm, mean_frequency_error, mean_magnitude_error, mean_phase_error, mean_chip_rate_error, error_code)

fetch_evm_trace(selector_string, timeout, evm)

Returns the EVM trace of the last averaging iteration.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name. Examples:

  ””

  ”signal::sig1”

  ”result::r1”

  ”signal::sig1/result::r1”

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

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. This value is expressed in seconds. 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.

• evm (numpy.float32) – This parameter returns the real signal values stored in an array. This value is expressed as a percentage.

Returns:

x0 (float):

This parameter returns the start time. This value is expressed in seconds.

dx (float):

This parameter returns the delta parameter.

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_iq_impairments(selector_string, timeout)

Returns the measured I/Q impairments.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name. Examples:

  ””

  ”signal::sig1”

  ”result::r1”

  ”signal::sig1/result::r1”

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

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. This value is expressed in seconds. 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:

mean_iq_origin_offset (float):

This parameter returns the mean averaged origin offset of the received signal. This value is expressed in dB.

mean_iq_gain_imbalance (float):

This parameter returns the mean I/Q gain imbalance of the received signal. This value is expressed in dB.

mean_iq_quadrature_error (float):

This parameter returns the mean I/Q quadrature error (phase imbalance) of the received signal. This value is expressed in degrees.

maximum_iq_origin_offset (float):

This parameter returns the maximum I/Q gain imbalance of the received signal. This value is expressed in dB.

maximum_iq_gain_imbalance (float):

This parameter returns the maximum origin offset of the received signal. This value is expressed in dB.

maximum_iq_quadrature_error (float):

This parameter returns the maximum I/Q quadrature error (phase imbalance) of the received signal. This value is expressed in degrees.

error_code (int):

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

Return type:

Tuple (mean_iq_origin_offset, mean_iq_gain_imbalance, mean_iq_quadrature_error, maximum_iq_origin_offset, maximum_iq_gain_imbalance, maximum_iq_quadrature_error, error_code)

fetch_magnitude_error_trace(selector_string, timeout, magnitude_error)

Returns the magnitude error trace of the last averaging iteration.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name. Examples:

  ””

  ”signal::sig1”

  ”result::r1”

  ”signal::sig1/result::r1”

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

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. This value is expressed in seconds. 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.

• magnitude_error (numpy.float32) – This parameter returns the array of the magnitude error values. This value is expressed as a percentage.

Returns:

x0 (float):

This parameter returns the start time. This value is expressed in seconds.

dx (float):

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

fetch_phase_error_trace(selector_string, timeout, phase_error)

Returns the phase error trace of the last averaging iteration.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name. Examples:

  ””

  ”signal::sig1”

  ”result::r1”

  ”signal::sig1/result::r1”

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

• timeout (float) – This parameter specifies the timeout for fetching the specified measurement. This value is expressed in seconds. 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.

• phase_error (numpy.float32) – This parameter returns the array of phase error values. This value is expressed in degrees.

Returns:

x0 (float):

This parameter returns the start time. This value is expressed in seconds.

dx (float):

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

get_maximum_chip_rate_error(selector_string)

Gets the maximum chip rate error. This value is expressed in parts per million (ppm).

You do not need to use a selector string to read this attribute for the default signal and result 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 maximum chip rate error. This value is expressed in parts per million (ppm).

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_maximum_frequency_error(selector_string)

Gets the maximum frequency error of the received signal. This value is expressed in Hz.

You do not need to use a selector string to read this attribute for the default signal and result 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 maximum frequency error of the received signal. This value is expressed in Hz.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_maximum_iq_gain_imbalance(selector_string)

Gets the maximum I/Q gain imbalance of the received signal. This value is expressed in dB.

You do not need to use a selector string to read this attribute for the default signal and result 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 maximum I/Q gain imbalance of the received 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_maximum_iq_origin_offset(selector_string)

Gets the maximum origin offset of the received signal. This value is expressed in dB.

You do not need to use a selector string to read this attribute for the default signal and result 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 maximum origin offset of the received 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_maximum_iq_quadrature_error(selector_string)

Gets the maximum I/Q quadrature error (phase imbalance) of the received signal. This value is expressed in degrees.

You do not need to use a selector string to read this attribute for the default signal and result 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 maximum I/Q quadrature error (phase imbalance) of the received signal. This value is expressed in degrees.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_maximum_magnitude_error(selector_string)

Gets the maximum magnitude error of the received signal. This value is expressed as a percentage.

You do not need to use a selector string to read this attribute for the default signal and result 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 maximum magnitude error of the received signal. 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_maximum_peak_evm(selector_string)

Gets the maximum peak EVM of the received signal. This value is expressed as a percentage.

You do not need to use a selector string to read this attribute for the default signal and result 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 maximum peak EVM of the received signal. 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_maximum_phase_error(selector_string)

Gets the maximum phase error of the received signal. This value is expressed in degrees.

You do not need to use a selector string to read this attribute for the default signal and result 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 maximum phase error of the received signal. This value is expressed in degrees.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_maximum_rms_evm(selector_string)

Gets the maximum RMS EVM of the received signal. This value is expressed as a percentage.

You do not need to use a selector string to read this attribute for the default signal and result 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 maximum RMS EVM of the received signal. 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_mean_chip_rate_error(selector_string)

Gets the mean chip rate error. This value is expressed in parts per million (ppm).

You do not need to use a selector string to read this attribute for the default signal and result 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 mean chip rate error. This value is expressed in parts per million (ppm).

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_frequency_error(selector_string)

Gets the mean averaged frequency error of the received signal. This value is expressed in Hz.

You do not need to use a selector string to read this attribute for the default signal and result 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 mean averaged frequency error of the received signal. This value is expressed in Hz.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_mean_iq_gain_imbalance(selector_string)

Gets the mean I/Q gain imbalance of the received signal. This value is expressed in dB.

You do not need to use a selector string to read this attribute for the default signal and result 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 mean I/Q gain imbalance of the received 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_mean_iq_origin_offset(selector_string)

Gets the mean averaged origin offset of the received signal. This value is expressed in dB.

You do not need to use a selector string to read this attribute for the default signal and result 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 mean averaged origin offset of the received 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_mean_iq_quadrature_error(selector_string)

Gets the mean I/Q quadrature error (phase imbalance) of the received signal. This value is expressed in degrees.

You do not need to use a selector string to read this attribute for the default signal and result 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 mean I/Q quadrature error (phase imbalance) of the received signal. This value is expressed in degrees.

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_magnitude_error(selector_string)

Gets the mean averaged magnitude error of the received signal. This value is expressed as a percentage.

You do not need to use a selector string to read this attribute for the default signal and result 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 mean averaged magnitude error of the received signal. 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_mean_peak_evm(selector_string)

Gets the mean averaged peak EVM of the received signal. This value is expressed as a percentage.

You do not need to use a selector string to read this attribute for the default signal and result 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 mean averaged peak EVM of the received signal. 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_mean_phase_error(selector_string)

Gets the mean averaged phase error of the received signal. This value is expressed in degrees.

You do not need to use a selector string to read this attribute for the default signal and result instance. Refer to the `Selector String <https://www.ni.com/docs/en-US/bundle/rfmx/page/selector-strings-net.html>`_s topic for information about the string syntax for named signals.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the mean averaged phase error of the received signal. This value is expressed in degrees.

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 mean averaged RMS EVM of the received signal. This value is expressed as a percentage.

You do not need to use a selector string to read this attribute for the default signal and result 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 mean averaged RMS EVM of the received signal. 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)