CdaResults

Provides methods to fetch and read the Cda measurement results.

class nirfmxwcdma.cda_results.CdaResults(signal_obj)

Bases: object

Provides methods to fetch and read the Cda measurement results.

fetch_code_domain_i_and_q_power(selector_string, timeout)

Fetches the I and Q mean active powers and I and Q peak inactive powers.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ”result::r1”

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

• timeout (float) – This parameter specifies the time for which the method waits for the measurement to complete. This value is expressed in seconds. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

i_mean_active_power (float):

This parameter returns the average code power among the set of active in-phase channels in the code domain. If you set the CDA_POWER_UNIT attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA_RESULTS_TOTAL_POWER attribute. This value is expressed in dB or dBm.

q_mean_active_power (float):

This parameter returns the average code power among the set of active quadrature-phase channels in the code domain. If you set the CDA Pwr Unit attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA Results Total Pwr attribute. This value is expressed in dB or dBm.

i_peak_inactive_power (float):

This parameter returns the largest code power among the set of inactive in-phase channels in the code domain. If you set the CDA Pwr Unit attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA Results Total Pwr attribute. This value is expressed in dB or dBm.

q_peak_inactive_power (float):

This parameter returns the largest code power among the set of inactive quadrature-phase channels in the code domain. If you set the CDA Pwr Unit attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA Results Total Pwr attribute. This value is expressed in dB or dBm.

error_code (int):

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

Return type:

Tuple (i_mean_active_power, q_mean_active_power, i_peak_inactive_power, q_peak_inactive_power, error_code)

fetch_code_domain_i_and_q_power_trace(selector_string, timeout)

Fetches the code domain power trace for I and Q branches. The code domain power is obtained for all codes with a spreading factor of 256, for I and Q branches separately.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ”result::r1”

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

• timeout (float) – This parameter specifies the time for which the method waits for the measurement to complete. This value is expressed in seconds. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

i_code_domain_powers (float):

This parameter returns an array of code domain powers for the in-phase component.

q_code_domain_powers (float):

This parameter returns an array of code domain powers for the quadrature-phase component.

error_code (int):

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

Return type:

Tuple (i_code_domain_powers, q_code_domain_powers, error_code)

fetch_code_domain_power(selector_string, timeout)

Fetches the Total Power , Total Active Power , Mean and Peak Active Powers, and Mean and Peak Inactive Powers.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ”result::r1”

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

• timeout (float) – This parameter specifies the time for which the method waits for the measurement to complete. This value is expressed in seconds. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

total_power (float):

This parameter returns the mean power of the received signal, sampled at ideal inter-symbol-interference free points. This value is expressed in dBm.

total_active_power (float):

This parameter returns the sum of all the active channel powers. If you set the CDA_POWER_UNIT attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA_RESULTS_TOTAL_POWER attribute. This value is expressed in dB or dBm.

mean_active_power (float):

This parameter returns the average of all the active channel powers. If you set the CDA Pwr Unit attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA Results Total Pwr attribute. This value is expressed in dB or dBm.

peak_active_power (float):

This parameter returns the largest code power among the set of active channels in the code domain. If you set the CDA Pwr Unit attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA Results Total Pwr attribute. This value is expressed in dB or dBm.

mean_inactive_power (float):

This parameter returns the average code power among the set of inactive channels in the code domain. If you set the CDA Pwr Unit attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA Results Total Pwr attribute. This value is expressed in dB or dBm.

peak_inactive_power (float):

This parameter returns the largest code power among the set of inactive channels in the code domain. If you set the CDA Pwr Unit attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA Results Total Pwr attribute. This value is expressed in dB or dBm.

error_code (int):

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

Return type:

Tuple (total_power, total_active_power, mean_active_power, peak_active_power, mean_inactive_power, peak_inactive_power, error_code)

fetch_code_domain_power_trace(selector_string, timeout)

Fetches the code domain power trace. The code domain power is obtained for all codes with spreading factor 256 for both I and Q branches in an interleaved manner.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ”result::r1”

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

• timeout (float) – This parameter specifies the time for which the method waits for the measurement to complete. This value is expressed in seconds. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

code_domain_powers (float):

This parameter returns an array of code domain powers for I and Q branches in an interleaved manner.

error_code (int):

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

Return type:

Tuple (code_domain_powers, error_code)

fetch_symbol_evm(selector_string, timeout)

Returns the root mean square and peak of symbol EVM, RMS of symbol magnitude error, RMS of symbol phase error, and mean symbol power, corresponding to the measurement channel.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ”result::r1”

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

• timeout (float) – This parameter specifies the time for which the method waits for the measurement to complete. This value is expressed in seconds. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

rms_symbol_evm (float):

This parameter returns the RMS EVM for the measurement channel. This value is expressed as a percentage.

peak_symbol_evm (float):

This parameter returns the peak EVM for the measurement channel. This value is expressed as a percentage.

rms_symbol_magnitude_error (float):

This parameter returns the RMS magnitude error for the measurement channel. This value is expressed as a percentage.

rms_symbol_phase_error (float):

This parameter returns the RMS phase error for the measurement channel. This value is expressed in degrees.

mean_symbol_power (float):

This parameter returns the mean power of the symbols for the measurement channel. This value is expressed in dB or dBm. If you set the CDA_POWER_UNIT attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA_RESULTS_TOTAL_POWER attribute.

chip_rate_error (float):

This parameter returns the chip rate error of the composite signal. This value is expressed in 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 (rms_symbol_evm, peak_symbol_evm, rms_symbol_magnitude_error, rms_symbol_phase_error, mean_symbol_power, chip_rate_error, error_code)

fetch_symbol_evm_trace(selector_string, timeout)

Fetches the root mean square EVM trace of the measurement channel.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ”result::r1”

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

• timeout (float) – This parameter specifies the time for which the method waits for the measurement to complete. This value is expressed in seconds. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

symbol_evm (float):

This parameter returns an array of RMS EVM values of the symbols of the measurement channel. 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 (symbol_evm, error_code)

fetch_symbol_magnitude_error_trace(selector_string, timeout)

Fetches the magnitude error trace of the measurement channel.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ”result::r1”

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

• timeout (float) – This parameter specifies the time for which the method waits for the measurement to complete. This value is expressed in seconds. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

symbol_magnitude_error (float):

This parameter returns an array of magnitude errors of the symbols of the measurement 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 (symbol_magnitude_error, error_code)

fetch_symbol_phase_error_trace(selector_string, timeout)

Fetches the phase error trace of the measurement channel.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ”result::r1”

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

• timeout (float) – This parameter specifies the time for which the method waits for the measurement to complete. This value is expressed in seconds. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

symbol_phase_error (float):

This parameter returns an array of phase errors of the symbols of the measurement channel. 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 (symbol_phase_error, error_code)

fetch_symbol_power_trace(selector_string, timeout)

Fetches the power versus time trace of the symbol corresponding to the measurement channel.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ”result::r1”

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

• timeout (float) – This parameter specifies the time for which the method waits for the measurement to complete. This value is expressed in seconds. A value of -1 specifies that the method waits until the measurement is complete. The default value is 10.

Returns:

symbol_powers (float):

This parameter returns the array of symbol powers of the measurement channel. This value is expressed in dBm.

error_code (int):

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

Return type:

Tuple (symbol_powers, error_code)

get_chip_rate_error(selector_string)

Gets the chip rate error of the composite signal. This value is expressed in ppm.

You do not need to use a selector string to read this result for the default signal and result instances. 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 of the composite signal. This value is expressed in 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_i_mean_active_power(selector_string)

Gets the average code power among the set of active in-phase channels in the code domain. If you set the CDA_POWER_UNIT attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA_RESULTS_TOTAL_POWER attribute. This value is expressed in dB or dBm.

You do not need to use a selector string to read this result for the default signal and result instances. 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 average code power among the set of active in-phase channels in the code domain. If you set the CDA_POWER_UNIT attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA_RESULTS_TOTAL_POWER attribute. This value is expressed in dB or dBm.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_i_peak_inactive_power(selector_string)

Gets the largest code power among the set of inactive in-phase channels in the code domain. If you set the CDA_POWER_UNIT attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA_RESULTS_TOTAL_POWER attribute. This value is expressed in dB or dBm.

You do not need to use a selector string to read this result for the default signal and result instances. 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 largest code power among the set of inactive in-phase channels in the code domain. If you set the CDA_POWER_UNIT attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA_RESULTS_TOTAL_POWER attribute. This value is expressed in dB or dBm.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_mean_active_power(selector_string)

Gets the average of all the active channel powers. If you set the CDA_POWER_UNIT attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA_RESULTS_TOTAL_POWER attribute. This value is expressed in dB or dBm.

You do not need to use a selector string to read this result for the default signal and result instances. 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 average of all the active channel powers. If you set the CDA_POWER_UNIT attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA_RESULTS_TOTAL_POWER attribute. This value is expressed in dB or dBm.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_mean_inactive_power(selector_string)

Gets the average code power among the set of inactive channels in the code domain. If you set the CDA_POWER_UNIT attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA_RESULTS_TOTAL_POWER attribute. This value is expressed in dB or dBm.

You do not need to use a selector string to read this result for the default signal and result instances. 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 average code power among the set of inactive channels in the code domain. If you set the CDA_POWER_UNIT attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA_RESULTS_TOTAL_POWER attribute. This value is expressed in dB or dBm.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_mean_symbol_power(selector_string)

Gets the mean power of the symbols for the measurement channel. This value is expressed in dB or dBm. If you set the CDA_POWER_UNIT attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA_RESULTS_TOTAL_POWER attribute.

You do not need to use a selector string to read this result for the default signal and result instances. 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 mean power of the symbols for the measurement channel. This value is expressed in dB or dBm. If you set the CDA_POWER_UNIT attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA_RESULTS_TOTAL_POWER attribute.

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

Gets the largest code power among the set of active channels in the code domain. If you set the CDA_POWER_UNIT attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA_RESULTS_TOTAL_POWER attribute. This value is expressed in dB or dBm.

You do not need to use a selector string to read this result for the default signal and result instances. 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 largest code power among the set of active channels in the code domain. If you set the CDA_POWER_UNIT attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA_RESULTS_TOTAL_POWER attribute. This value is expressed in dB or dBm.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_peak_inactive_power(selector_string)

Gets the largest code power among the set of inactive channels in the code domain. If you set the CDA_POWER_UNIT attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA_RESULTS_TOTAL_POWER attribute. This value is expressed in dB or dBm.

You do not need to use a selector string to read this result for the default signal and result instances. 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 largest code power among the set of inactive channels in the code domain. If you set the CDA_POWER_UNIT attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA_RESULTS_TOTAL_POWER attribute. This value is expressed in dB or dBm.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_peak_symbol_evm(selector_string)

Gets the peak EVM for the measurement channel. 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 instances. 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 for the measurement channel. 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_q_mean_active_power(selector_string)

Gets the average code power among the set of active quadrature-phase channels in the code domain. If you set the CDA_POWER_UNIT attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA_RESULTS_TOTAL_POWER attribute. This value is expressed in dB or dBm.

You do not need to use a selector string to read this result for the default signal and result instances. 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 average code power among the set of active quadrature-phase channels in the code domain. If you set the CDA_POWER_UNIT attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA_RESULTS_TOTAL_POWER attribute. This value is expressed in dB or dBm.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_q_peak_inactive_power(selector_string)

Gets the largest code power among the set of inactive quadrature-phase channels in the code domain. If you set the CDA_POWER_UNIT attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA_RESULTS_TOTAL_POWER attribute. This value is expressed in dB or dBm.

You do not need to use a selector string to read this result for the default signal and result instances. 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 largest code power among the set of inactive quadrature-phase channels in the code domain. If you set the CDA_POWER_UNIT attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA_RESULTS_TOTAL_POWER attribute. This value is expressed in dB or dBm.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_rms_symbol_evm(selector_string)

Gets the RMS EVM for the measurement channel. 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 instances. 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 for the measurement channel. 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_symbol_magnitude_error(selector_string)

Gets the RMS magnitude error for the measurement channel. 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 instances. 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 for the measurement channel. 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_symbol_phase_error(selector_string)

Gets the RMS phase error for the measurement channel. 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 instances. 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 for the measurement channel. 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_total_active_power(selector_string)

Gets the sum of all the active channel powers. If you set the CDA_POWER_UNIT attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA_RESULTS_TOTAL_POWER attribute. This value is expressed in dB or dBm.

You do not need to use a selector string to read this result for the default signal and result instances. 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 sum of all the active channel powers. If you set the CDA_POWER_UNIT attribute to dBm, the measurement returns an absolute value; otherwise, the measurement returns a value relative to the CDA_RESULTS_TOTAL_POWER attribute. This value is expressed in dB or dBm.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_total_power(selector_string)

Gets the mean power of the received signal, sampled at ideal inter-symbol-interference free points. This value is expressed in dBm.

You do not need to use a selector string to read this result for the default signal and result instances. 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 mean power of the received signal, sampled at ideal inter-symbol-interference free points. This value is expressed in dBm.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)