ModAccResults

Provides methods to fetch and read the ModAcc measurement results.

class nirfmxcdma2k.modacc_results.ModAccResults(signal_obj)

Bases: object

Provides methods to fetch and read the ModAcc measurement results.

fetch_constellation_trace(selector_string, timeout, constellation)

Returns the complex chips of the corrected composite signal for the modulation accuracy (ModAcc) 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 ModAcc 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_detected_channel(selector_string, timeout)

Returns a detected channel by its channel name.

Use “channel<n>” as the selector string to read results from this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name, and channel number. Examples:

  ”channel0”

  ”signal::sig1/channel0”

  ”result::r1/channel0”

  ”signal::sig1/result::r1/channel0”

  You can use the build_channel_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:

detected_walsh_code_length (int):

This parameter returns the detected Walsh code length.

detected_walsh_code_number (int):

This parameter returns the detected Walsh code number.

detected_branch (enums.ModAccDetectedBranch):

This parameter returns the detected branch.

Name (value)	Description
I (0)	The signal modulated on the in-phase branch.
Q (1)	The signal modulated on the quadrature branch.
I and Q (2)	The signal modulated on the in-phase branch and quadrature branch.

error_code (int):

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

Return type:

Tuple (detected_walsh_code_length, detected_walsh_code_number, detected_branch, error_code)

fetch_detected_channel_array(selector_string, timeout)

Returns the detected channels. If you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined, the measurement returns the configured channels.

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:

detected_walsh_code_length (int):

This parameter returns the array of the detected Walsh code length.

detected_walsh_code_number (int):

This parameter returns the array of the detected Walsh code number.

detected_branch (enums.ModAccDetectedBranch):

This parameter returns the array of the detected branch.

Name (value)	Description
I (0)	The signal modulated on the in-phase branch.
Q (1)	The signal modulated on the quadrature branch.
I and Q (2)	The signal modulated on the in-phase branch and quadrature branch.

error_code (int):

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

Return type:

Tuple (detected_walsh_code_length, detected_walsh_code_number, detected_branch, error_code)

fetch_evm(selector_string, timeout)

Returns the EVM value and related measurement values of the modulation accuracy (ModAcc) of the CDMA2k signal.

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:

rms_evm (float):

This parameter returns the RMS EVM of the composite signal. This value is expressed as a percentage.

peak_evm (float):

This parameter returns the peak value of the uplink EVM. This value is expressed as a percentage.

rho (float):

This parameter returns the correlation of the received signal with the reference signal normalized by the signal power.

frequency_error (float):

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

chip_rate_error (float):

This parameter returns the frequency error. This value is expressed in Hz.

rms_magnitude_error (float):

This parameter returns the RMS magnitude error of the composite signal. This value is expressed as a percentage.

rms_phase_error (float):

This parameter returns the RMS phase error of the composite signal. This value is expressed in degrees (deg).

error_code (int):

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

Return type:

Tuple (rms_evm, peak_evm, rho, frequency_error, chip_rate_error, rms_magnitude_error, rms_phase_error, error_code)

fetch_evm_trace(selector_string, timeout, evm)

Returns the EVM trace of the ModAcc 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.

• 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 origin offset, gain imbalance, and quadrature error.

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:

iq_origin_offset (float):

This parameter returns the I/Q origin offset of the composite signal. This value is expressed in dB.

iq_gain_imbalance (float):

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

iq_quadrature_error (float):

This parameter returns the I/Q quadrature error of the composite 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 (iq_origin_offset, iq_gain_imbalance, iq_quadrature_error, error_code)

fetch_magnitude_error_trace(selector_string, timeout, magnitude_error)

Returns the magnitude error trace for the modulation accuracy (ModAcc) 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.

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

Returns the total number of detected channels. If the you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined, the measurement returns the number of configured channels.

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:

number_of_detected_channels (int):

This parameter returns the total number of detected channels.

error_code (int):

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

Return type:

Tuple (number_of_detected_channels, error_code)

fetch_peak_active_cde(selector_string, timeout)

Returns the peak value among the code domain errors of the active channels, along with the code number and the code length.

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:

peak_active_cde (float):

This parameter returns the peak value of all CDEs of the active channels. This value is expressed in dB.

peak_active_cde_walsh_code_length (int):

This parameter returns the Walsh code length of the channel corresponding to the Peak Active CDE value.

peak_active_cde_walsh_code_number (int):

This parameter returns the Walsh code number of the channel corresponding to the Peak Active CDE value.

peak_active_cde_branch (enums.ModAccPeakActiveCdeBranch):

This parameter returns the branch of the channel corresponding to the Peak Active CDE value.

Name (value)	Description
I (0)	The signal is modulated on the in-phase branch.
Q (1)	The signal is modulated on the quadrature branch.

error_code (int):

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

Return type:

Tuple (peak_active_cde, peak_active_cde_walsh_code_length, peak_active_cde_walsh_code_number, peak_active_cde_branch, error_code)

fetch_peak_cde(selector_string, timeout)

Returns the maximum value among the code domain errors (CDEs), in dB.

This method calculates the CDEs by projecting the descrambled error vector onto the code domain at a specific spreading factor.

The CDE for every code with a specific spreading factor is defined as the ratio of the mean power of the projection onto that code to the mean power of the composite reference waveform. A fixed spreading factor of 32 is used.

This method computes the CDEs separately for I and Q branches.

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:

peak_cde (float):

This parameter returns the maximum value among the code domain errors. This value is expressed in dB.

peak_cde_walsh_code_number (int):

This parameter returns the code number of the channel corresponding to the Peak CDE value.

peak_cde_branch (enums.ModAccPeakCdeBranch):

This parameter returns the branch of the channel corresponding to the Peak CDE value.

Name (value)	Description
I (0)	The signal is modulated on the in-phase branch.
Q (1)	The signal is modulated on the quadrature branch.

error_code (int):

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

Return type:

Tuple (peak_cde, peak_cde_walsh_code_number, peak_cde_branch, error_code)

fetch_phase_error_trace(selector_string, timeout, phase_error)

Returns the phase error trace of the ModAcc 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.

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

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

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

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

Gets the branch of the detected channel. If you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined, the attribute returns the branch of the configured channel.

Use “channel< <format type=”monospace-italic”>n</format> >” as the Selector String to read this attribute.

Name (Value)	Description
I (0)	The signal modulated on the in-phase branch.
Q (1)	The signal modulated on the quadrature branch.
I and Q (2)	The signal modulated on the in-phase branch and quadrature branch.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccDetectedBranch):

Returns the branch of the detected channel. If you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined, the attribute returns the branch of the configured channel.

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

Gets the Walsh code length of the detected channel. If you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined, the attribute returns the Walsh code length of the configured channel.

Use “channel< <format type=”monospace-italic”>n</format> >” as the Selector String to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the Walsh code length of the detected channel. If you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined, the attribute returns the Walsh code length of the configured channel.

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

Gets the Walsh code number of the detected channel. If you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined, the attribute returns the Walsh code number of the configured channel.

Use “channel< <format type=”monospace-italic”>n</format> >” as the Selector String to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the Walsh code number of the detected channel. If you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined, the attribute returns the Walsh code number of the configured channel.

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

Gets the frequency error averaged over all measured slots. This value is expressed in Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the frequency error averaged over all measured slots. 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_gain_imbalance(selector_string)

Gets the I/Q gain imbalance of the composite signal averaged over all measured slots. This value is expressed in dB.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the I/Q gain imbalance of the composite signal averaged over all measured slots. 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_origin_offset(selector_string)

Gets the I/Q origin offset of the composite signal averaged over all measured slots. This value is expressed in dB.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the I/Q origin offset of the composite signal averaged over all measured slots. 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_quadrature_error(selector_string)

Gets the I/Q quadrature error of the composite signal, averaged over all measured slots. This value is expressed in degrees.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the I/Q quadrature error of the composite signal, averaged over all measured slots. 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_number_of_detected_channels(selector_string)

Gets the total number of detected channels. If you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined, the attribute returns the number of configured channels.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the total number of detected channels. If you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined, the attribute returns the number of configured channels.

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

Gets the maximum value among the code domain errors (CDEs) for all active channels. This value is expressed in dB. The active CDEs are computed by projecting the descrambled error vector onto the codes of each active channel. The active CDE is defined as the ratio of the mean power of the projection onto that code to the mean power of the composite reference waveform.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the maximum value among the code domain errors (CDEs) for all active channels. This value is expressed in dB. The active CDEs are computed by projecting the descrambled error vector onto the codes of each active channel. The active CDE is defined as the ratio of the mean power of the projection onto that code to the mean power of the composite 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_peak_active_cde_branch(selector_string)

Gets the branch of the channel corresponding to the value that the MODACC_RESULTS_PEAK_ACTIVE_CDE attribute returns.

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

Name (Value)	Description
I (0)	The signal is modulated on the in-phase branch.
Q (1)	The signal is modulated on the quadrature branch.
I and Q (2)	Complex modulated signal.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccPeakActiveCdeBranch):

Returns the branch of the channel corresponding to the value that the MODACC_RESULTS_PEAK_ACTIVE_CDE attribute returns.

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

Gets the Walsh code length of the channel corresponding to the value that the MODACC_RESULTS_PEAK_ACTIVE_CDE attribute returns.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the Walsh code length of the channel corresponding to the value that the MODACC_RESULTS_PEAK_ACTIVE_CDE attribute returns.

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

Gets the Walsh code number of the channel corresponding to the value that the MODACC_RESULTS_PEAK_ACTIVE_CDE attribute returns.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the Walsh code number of the channel corresponding to the value that the MODACC_RESULTS_PEAK_ACTIVE_CDE attribute returns.

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

Gets the maximum value among the code domain errors (CDEs). This value is expressed in dB. The CDEs are computed by projecting the descrambled error vector onto the code domain at a specific spreading factor. The CDE for every code with a specific spreading factor is defined as the ratio of the mean power of the projection onto that code to the mean power of the composite reference waveform. A fixed spreading factor of 16 is used. The CDEs are computed separately for I and Q branches.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the maximum value among the code domain errors (CDEs). This value is expressed in dB. The CDEs are computed by projecting the descrambled error vector onto the code domain at a specific spreading factor. The CDE for every code with a specific spreading factor is defined as the ratio of the mean power of the projection onto that code to the mean power of the composite reference waveform. A fixed spreading factor of 16 is used. The CDEs are computed separately for I and Q branches.

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

Gets the branch corresponding to the value that the MODACC_RESULTS_PEAK_ACTIVE_CDE attribute returns.

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

Name (Value)	Description
I (0)	The signal is modulated on the in-phase branch.
Q (1)	The signal is modulated on the quadrature branch.
I and Q (2)	Complex modulated signal.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccPeakCdeBranch):

Returns the branch corresponding to the value that the MODACC_RESULTS_PEAK_ACTIVE_CDE attribute returns.

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

Gets the Walsh code number corresponding to the value that the MODACC_RESULTS_PEAK_CDE attribute returns.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the Walsh code number corresponding to the value that the MODACC_RESULTS_PEAK_CDE attribute returns.

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

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

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the peak EVM of the composite 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_rho(selector_string)

Gets the correlation of the received signal with the reference signal normalized by the signal power. The value of Rho is between 0 and 1.0, inclusive. A value of 1.0 indicates that the received signal and the reference signal are perfectly correlated.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the correlation of the received signal with the reference signal normalized by the signal power. The value of Rho is between 0 and 1.0, inclusive. A value of 1.0 indicates that the received signal and the reference signal are perfectly correlated.

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

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

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the RMS EVM of the composite 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_rms_magnitude_error(selector_string)

Gets the RMS magnitude error of the composite signal. This value is expressed as a percentage.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the RMS magnitude error of the composite 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_rms_phase_error(selector_string)

Gets the RMS phase error of the composite signal. This value is expressed in degrees.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the RMS phase error of the composite 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_slot_timing_error(selector_string)

Gets the measured timing error from the beginning of the acquisition to the location of the first slot acquired. This value is expressed in seconds.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the measured timing error from the beginning of the acquisition to the location of the first slot acquired. 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)