DDemodResults

Provides methods to fetch and read the DDemod measurement results.

class nirfmxdemod.digital_demod_results.DDemodResults(signal_obj)

Bases: object

Provides methods to fetch and read the DDemod measurement results.

fetch_carrier_measurement(selector_string, timeout)

Fetches the carrier measurement.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and 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 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. This value is expressed in seconds.

Returns:

mean_frequency_offset (float):

This parameter returns the mean of the measured carrier frequency offset, in Hz.

mean_frequency_drift (float):

This parameter returns the mean of the measured carrier frequency drift, in Hz.

mean_phase_error (float):

This parameter returns the mean of the measured phase offset, in degrees, from the transmitted carrier phase.

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_frequency_offset, mean_frequency_drift, mean_phase_error, error_code)

fetch_constellation_trace(selector_string, timeout, constellation_trace)

Fetches the constellation trace.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and 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 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. This value is expressed in seconds.

• constellation_trace (numpy.complex64) – This parameter returns the constellation trace.

Returns:

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

Return type:

int

fetch_demodulated_bits(selector_string, timeout, demodulated_bits)

Fetches the demodulated bit stream.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and 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 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. This value is expressed in seconds.

• demodulated_bits (numpy.int8) – This parameter returns the demodulated bit stream.

Returns:

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

Return type:

int

fetch_equalizer_coefficients(selector_string, timeout, equalizer_coefficients)

Fetches the updated equalizer coefficients.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and 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 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. This value is expressed in seconds.

• 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 as a fraction of the symbol spacing. For example, if four coefficients correspond to one symbol, the spacing is 1/4.

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

Fetches the EVM measurements.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and 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 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. This value is expressed in seconds.

Returns:

mean_rms_evm (float):

This parameter returns the mean of the RMS EVM, as a percentage, measured per acquisition.

maximum_rms_evm (float):

This parameter returns the maximum of the RMS EVM, as a percentage, measured per acquisition.

mean_modulation_error_ratio (float):

This parameter returns the modulation error ratio, in dB.

maximum_peak_evm (float):

This parameter returns the maximum of the peak EVM measured per acquisition.

mean_peak_evm (float):

This parameter returns the mean of the peak EVM measured per acquisition.

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_rms_evm, mean_modulation_error_ratio, maximum_peak_evm, mean_peak_evm, error_code)

fetch_evm_trace(selector_string, timeout, evm)

Fetches the EVM trace.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and 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 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. This value is expressed in seconds.

• evm (numpy.float32) – This parameter returns the EVM measured per symbol.

Returns:

x0 (float):

This parameter returns the start symbol index.

dx (float):

This parameter returns the spacing between symbols normalized to symbol rate.

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

Fetches the frequency-shift keying (FSK) deviation trace.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and 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 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. This value is expressed in seconds.

• fsk_error (numpy.float32) – This parameter returns the mean of the RMS frequency error of the FSK symbols measured per acquisition.

Returns:

x0 (float):

This parameter returns the start symbol index.

dx (float):

This parameter returns the spacing between symbols normalized to symbol rate.

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

Fetches frequency-shift keying (FSK) results.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and 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 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. This value is expressed in seconds.

Returns:

mean_fsk_deviation (float):

This parameter returns the measured FSK deviation, in Hz.

mean_rms_fsk_error (float):

This parameter returns the mean of the RMS frequency error, in Hz, of the FSK symbols measured per acquisition.

maximum_peak_fsk_error (float):

This parameter returns the maximum of peak frequency error of the FSK symbols measured per acquisition.

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_fsk_deviation, mean_rms_fsk_error, maximum_peak_fsk_error, error_code)

fetch_iq_impairments(selector_string, timeout)

Fetches I/Q impairments.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and 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 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. This value is expressed in seconds.

Returns:

mean_iq_gain_imbalance (float):

This parameter returns the measured ratio of I gain to Q gain, in dB.

mean_quadrature_skew (float):

This parameter returns a measure of I and Q components in the signal that are not perfectly orthogonal.

mean_iq_origin_offset (float):

This parameter returns the offset, in dB, from the ideal location of the constellation origin.

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_gain_imbalance, mean_quadrature_skew, mean_iq_origin_offset, error_code)

fetch_magnitude_error(selector_string, timeout)

Fetches the magnitude error measurements.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and 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 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. This value is expressed in seconds.

Returns:

mean_magnitude_error (float):

This parameter returns the mean of the magnitude error measured per acquisition.

maximum_magnitude_error (float):

This parameter returns the maximum of the magnitude error measured per acquisition.

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_magnitude_error, maximum_magnitude_error, error_code)

fetch_magnitude_error_trace(selector_string, timeout, magnitude_error)

Fetches the magnitude error trace.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and 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 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. This value is expressed in seconds.

• magnitude_error (numpy.float32) – This parameter returns the magnitude error.

Returns:

x0 (float):

This parameter returns the start symbol index.

dx (float):

This parameter returns the spacing between symbols normalized to symbol rate.

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

Fetches the mean amplitude droop per symbol.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and 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 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. This value is expressed in seconds.

Returns:

mean_amplitude_droop (float):

This parameter returns the mean amplitude droop per symbol.

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_amplitude_droop, error_code)

fetch_mean_iq_origin_offset(selector_string, timeout)

Fetches the offset, in dB, from the ideal location of the constellation origin.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and 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 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. This value is expressed in seconds.

Returns:

mean_iq_origin_offset (float):

This parameter returns the offset, in dB, from the ideal location of the constellation origin.

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, error_code)

fetch_mean_quadrature_skew(selector_string, timeout)

Fetches the mean quadrature skew.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and 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 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. This value is expressed in seconds.

Returns:

mean_quadrature_skew (float):

This parameter returns a measure of I and Q components in the signal that are not perfectly orthogonal. Quadrature error can be either positive or negative, with the sign indicating the orientation of the error.

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_quadrature_skew, error_code)

fetch_mean_rho_factor(selector_string, timeout)

Fetches the correlation of the measurement waveform and the reference waveform.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and 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 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. This value is expressed in seconds.

Returns:

mean_rho_factor (float):

This parameter returns the correlation of the measurement waveform and the 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 (mean_rho_factor, error_code)

fetch_measurement_waveform(selector_string, timeout, measurement_waveform)

Fetches the measurement waveform.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and 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 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. This value is expressed in seconds.

• measurement_waveform (numpy.complex64) – This parameter returns the measured samples.

Returns:

x0 (float):

This parameter returns the start sample index.

dx (float):

This parameter returns the spacing between samples normalized to samples per symbol.

samples_per_symbol (int):

This parameter returns the samples per symbol.

symbol_rate (float):

This parameter returns the symbol rate in Hz.

The default value is 100 kHz.

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, samples_per_symbol, symbol_rate, error_code)

fetch_offset_constellation_trace(selector_string, timeout, offset_constellation_trace)

Fetches the offset constellation trace.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and 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 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. This value is expressed in seconds.

• offset_constellation_trace (numpy.complex64) – This parameter returns the offset constellation trace.

Returns:

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

Return type:

int

fetch_offset_evm(selector_string, timeout)

Fetches the offset error vector magnitude (EVM).

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and 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 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. This value is expressed in seconds.

Returns:

mean_rms_offset_evm (float):

This parameter returns the mean of the RMS EVM, measured per acquisition, after removing the offset between the I and Q channels of OQPSK demodulated signal.

maximum_rms_offset_evm (float):

This parameter returns the mean of the RMS EVM, measured per acquisition, after removing the offset between the I and Q channels of OQPSK demodulated signal.

maximum_peak_offset_evm (float):

This parameter returns the maximum of the peak EVM, measured per acquisition, after removing the offset between the I and Q channels of OQPSK demodulated signal.

mean_peak_offset_evm (float):

This parameter returns the mean of the peak EVM, measured per acquisition, after removing the offset between the I and Q channels of OQPSK demodulated signal.

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_offset_evm, maximum_rms_offset_evm, maximum_peak_offset_evm, mean_peak_offset_evm, error_code)

fetch_offset_evm_trace(selector_string, timeout, offset_evm)

Fetches the offset error vector magnitude (EVM) trace measured on OQPSK signal.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and 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 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. This value is expressed in seconds.

• offset_evm (numpy.float32) – This parameter returns the offset EVM trace.

Returns:

x0 (float):

This parameter returns the start symbol index.

dx (float):

This parameter returns the spacing between symbols normalized to symbol rate.

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

Fetches the phase error measurements.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and 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 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. This value is expressed in seconds.

Returns:

mean_phase_error (float):

This parameter returns the mean of the phase error.

maximum_phase_error (float):

This parameter returns the maximum of the phase error.

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_phase_error, maximum_phase_error, error_code)

fetch_phase_error_trace(selector_string, timeout, phase_error)

Fetches the phase error trace.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and 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 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. This value is expressed in seconds.

• phase_error (numpy.float32) – This parameter returns the phase error.

Returns:

x0 (float):

This parameter returns the start symbol index.

dx (float):

This parameter returns the spacing between symbols normalized to symbol rate.

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

Fetches the reference waveform.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and 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 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. This value is expressed in seconds.

• reference_waveform (numpy.complex64) – This parameter returns the reference samples.

Returns:

x0 (float):

This parameter returns the start sample index.

dx (float):

This parameter returns the spacing between samples normalized to samples per symbol.

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

Indicates whether synchronization bits were found in the demodulated symbol.

Parameters:

• selector_string (string) –

  This parameter comprises the signal name and 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 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. This value is expressed in seconds.

Returns:

sync_found (bool):

This parameter returns TRUE if the synchronization bits was found in the demodulated signal.

error_code (int):

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

Return type:

Tuple (sync_found, error_code)

get_carrier_mean_frequency_drift(selector_string)

Gets the measured carrier frequency drift. This value is expressed in Hz.

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 measured carrier frequency drift. 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_carrier_mean_frequency_offset(selector_string)

Gets the measured frequency offset from the transmitted carrier frequency. This value is expressed in Hz.

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 measured frequency offset from the transmitted carrier frequency. 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_carrier_mean_phase_error(selector_string)

Gets the measured phase offset from the transmitted carrier phase. This value is expressed in degrees.

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 measured phase offset from the transmitted carrier phase. 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_evm_maximum_peak(selector_string)

Gets the maximum of the peak EVM measured per acquisition, as a percentage.

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 maximum of the peak EVM measured per acquisition, 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_evm_maximum_rms(selector_string)

Gets the maximum of the RMS EVM measured per acquisition, as a percentage.

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 maximum of the RMS EVM measured per acquisition, 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_evm_mean_modulation_error_ratio(selector_string)

Gets the modulation error ratio. 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 modulation error ratio. 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_evm_mean_peak(selector_string)

Gets the mean of the peak EVM measured per acquisition, as a percentage.

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 mean of the peak EVM measured per acquisition, 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_evm_mean_rms(selector_string)

Gets the mean of the RMS EVM measured per acquisition, as a percentage.

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 mean of the RMS EVM measured per acquisition, 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_fsk_maximum_peak_fsk_error(selector_string)

Gets the maximum of peak frequency error of the FSK symbols measured per acquisition. This value is expressed in Hz.

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 maximum of peak frequency error of the FSK symbols measured per acquisition. 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_fsk_mean_deviation(selector_string)

Gets the reference FSK deviation used to measure the FSK error. This value is expressed in Hz.

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 reference FSK deviation used to measure the FSK error. 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_fsk_mean_rms_fsk_error(selector_string)

Gets the mean of the RMS frequency error of the FSK symbols measured per acquisition. This value is expressed in Hz.

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 mean of the RMS frequency error of the FSK symbols measured per acquisition. 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_iq_impairments_mean_iq_gain_imbalance(selector_string)

Gets the measured ratio of I gain to Q gain. 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 measured ratio of I gain to Q gain. 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_iq_impairments_mean_iq_origin_offset(selector_string)

Gets the offset from the ideal location of the constellation origin. 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 offset from the ideal location of the constellation origin. 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_iq_impairments_mean_quadrature_skew(selector_string)

Gets a measure of I and Q components in the signal that are not perfectly orthogonal. Quadrature error can be either positive or negative, with the sign indicating the orientation of the error.

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 a measure of I and Q components in the signal that are not perfectly orthogonal. Quadrature error can be either positive or negative, with the sign indicating the orientation of the error.

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

Gets the maximum of the magnitude error measured per acquisition, as a percentage.

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 maximum of the magnitude error measured per acquisition, 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_magnitude_error_mean(selector_string)

Gets the mean of the magnitude error measured per acquisition, as a percentage.

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 mean of the magnitude error measured per acquisition, 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_amplitude_droop(selector_string)

Gets the mean amplitude droop per symbol.

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 mean amplitude droop per symbol.

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

Gets the correlation of the measurement waveform and the 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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the correlation of the measurement waveform and the 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_offset_evm_maximum_peak(selector_string)

Gets the maximum of the peak EVM, as a percentage, measured per acquisition, after removing the offset between the I and Q channels of OQPSK demodulated signal.

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 maximum of the peak EVM, as a percentage, measured per acquisition, after removing the offset between the I and Q channels of OQPSK demodulated signal.

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

Gets the maximum of the RMS EVM, as a percentage, measured per acquisition, after removing the offset between the I and Q channels of OQPSK demodulated signal.

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 maximum of the RMS EVM, as a percentage, measured per acquisition, after removing the offset between the I and Q channels of OQPSK demodulated signal.

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

Gets the mean of the peak EVM, as a percentage, measured per acquisition, after removing the offset between the I and Q channels of OQPSK demodulated signal.

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 mean of the peak EVM, as a percentage, measured per acquisition, after removing the offset between the I and Q channels of OQPSK demodulated signal.

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

Gets the mean of the RMS EVM, as a percentage, measured per acquisition, after removing the offset between the I and Q channels of OQPSK demodulated signal.

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 mean of the RMS EVM, as a percentage, measured per acquisition, after removing the offset between the I and Q channels of OQPSK demodulated signal.

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

Gets the maximum of the phase error measured per acquisition. This value is expressed in degrees.

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 maximum of the phase error measured per acquisition. 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_phase_error_mean(selector_string)

Gets the mean of the phase error measured per acquisition. This value is expressed in degrees.

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 mean of the phase error measured per acquisition. 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_sync_found(selector_string)

Indicates whether the synchronization bits were found in the demodulated signal.

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 (bool):

Indicates whether the synchronization bits were found in the demodulated signal.

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)

read(selector_string, timeout)

Configures hardware for acquisition, performs measurement on acquired data for modulation type configured using the configure_modulation_type() method, and returns the frequency offset, EVM, and MER results.

Parameters:

• selector_string (string) –

  This parameter comprises of the signal name.

  Example:

  ””

  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. 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. This value is expressed in seconds.

Returns:

mean_frequency_offset (float):

This parameter returns the mean of the measured carrier frequency offset, in Hz.

mean_rms_evm (float):

This parameter returns the mean of the RMS EVM measured per acquisition.

maximum_peak_evm (float):

This parameter returns the maximum of the peak EVM measured per acquisition.

mean_modulation_error_ratio (float):

This parameter returns the modulation error ratio, 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 (mean_frequency_offset, mean_rms_evm, maximum_peak_evm, mean_modulation_error_ratio, error_code)