ModAccResults

Provides methods to fetch and read the ModAcc measurement results.

class nirfmxwcdma.modacc_results.ModAccResults(signal_obj)

Bases: object

Provides methods to fetch and read the ModAcc measurement results.

fetch_constellation_trace(selector_string, timeout, constellation)

Fetches the complex chips of the composite corrected signal of a carrier for the ModAcc measurement.

Use “carrier<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 carrier number.

  Example:

  ”carrier0”

  ”result::r1/carrier0”

  You can use the build_carrier_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.

• constellation (numpy.complex64) – This parameter returns an array of complex chips of the corrected signal of a carrier on which the ModAcc measurements are done. 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 the spreading factor, spreading code, modulation type, and branch of the detected channel of a carrier in the ModAcc measurement.

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

Parameters:

• selector_string (string) –

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

  Example:

  ”carrier0/channel0”

  ”result::r1/carrier0/channel0”

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

detected_spreading_factor (int):

This parameter returns the spreading factors of the detected channels when you set the CHANNEL_CONFIGURATION_MODE attribute to Auto Detect. If you set the Channel Configuration Mode attribute to User Defined or Test Model, the measurement returns the spreading factor of the configured channel of a carrier.

detected_spreading_code (int):

This parameter returns the spreading code of the detected channels when you set the Channel Configuration Mode attribute to Auto Detect. If you set the Channel Configuration Mode attribute to User Defined or Test Model, the measurement returns the spreading code of the configured channel of a carrier.

detected_modulation_type (enums.ModAccDetectedModulationType):

This parameter returns the modulation type of the detected channels when you set the Channel Configuration Mode attribute to Auto Detect. If you set the Channel configuration Mode attribute to User Defined or Test Model, the measurement returns the modulation type of the configured channel of a carrier.

Name (Value)	Description
BPSK/QPSK (0)	The modulation type is BPSK.
4PAM/16QAM (1)	The modulation type is 4-PAM.

detected_branch (enums.ModAccDetectedBranch):

This parameter returns the branch of the detected channels when you set the Channel Configuration Mode attribute to Auto Detect. If you set the Channel Configuration Mode attribute to User Defined or Test Model, the measurement returns the branch of the configured channel of a carrier.

Name (Value)	Description
I (0)	The signal is modulated in the in-phase branch.
Q (1)	The signal is modulated in the quadrature-phase 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_spreading_factor, detected_spreading_code, detected_modulation_type, detected_branch, error_code)

fetch_detected_channel_array(selector_string, timeout)

Fetches an array of spreading factors, an array of spreading codes, an array of modulation types, and an array of branches of the detected channels of the carriers, when you set the CHANNEL_CONFIGURATION_MODE attribute to Auto Detect for the ModAcc measurement. When you set the Channel Configuration Mode attribute to User Defined or Test Model, it returns the corresponding results for the configured channels of all the carriers.

Use “carrier<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 carrier number.

  Example:

  ”carrier0”

  ”result::r1/carrier0”

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

detected_spreading_factor (int):

This parameter returns an array of spreading factors of the detected channels, when you set the CHANNEL_CONFIGURATION_MODE attribute to Auto Detect. If you set the Channel Configuration Mode attribute to User Defined or Test Model, the measurement returns an array of spreading factors of the configured channels.

detected_spreading_code (int):

This parameter returns an array of spreading codes of the detected channels, when you set the Channel Configuration Mode attribute to Auto Detect. If you set the Channel Configuration Mode attribute to User Defined or Test Model, the measurement returns an array of spreading codes of the configured channels.

detected_modulation_type (enums.ModAccDetectedModulationType):

This parameter returns an array of modulation types of the detected channels, when you set the Channel Configuration Mode attribute to Auto Detect. If you set the Channel Configuration Mode attribute to User Defined or Test Model, the measurement returns an array of modulation types of the configured channels.

Name (Value)	Description
BPSK/QPSK (0)	The modulation type is BPSK.
4PAM/16QAM (1)	The modulation type is 4-PAM.

detected_branch (enums.ModAccDetectedBranch):

This parameter returns an array of branches of the detected channels when you set the Channel Configuration Mode attribute to Auto Detect. If you set the Channel Configuration Mode attribute to User Defined or Test Model, the measurement returns an array of branches of the configured channels.

Name (Value)	Description
I (0)	The signal is modulated in the in-phase branch.
Q (1)	The signal is modulated in the quadrature-phase 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_spreading_factor, detected_spreading_code, detected_modulation_type, detected_branch, error_code)

fetch_evm(selector_string, timeout)

Fetches the chip rate error, frequency error, RMS EVM, peak EVM, Rho, RMS magnitude error, and RMS phase error of the complex chips of the corrected composite signal for a carrier in the ModAcc measurement.

Use “carrier<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 carrier number.

  Example:

  ”carrier0”

  ”result::r1/carrier0”

  You can use the build_carrier_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_evm (float):

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

peak_evm (float):

This parameter returns the peak EVM of the composite signal for a carrier. 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 for a carrier.

Valid values range from 0 to 1.0, inclusive. The maximum value of Rho is 1.0, which indicates that the received signal and reference signal are perfectly correlated.

frequency_error (float):

This parameter returns the frequency offset of the composite signal for a carrier. This value is expressed in Hz.

chip_rate_error (float):

This parameter returns the chip rate error of the composite signal for a carrier. This value is expressed in ppm.

rms_magnitude_error (float):

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

rms_phase_error (float):

This parameter returns the RMS phase error of the composite signal for a carrier. 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 (rms_evm, peak_evm, rho, frequency_error, chip_rate_error, rms_magnitude_error, rms_phase_error, error_code)

fetch_evm_array(selector_string, timeout)

Fetches an array of chip rate errors, an array of frequency errors, an array of RMS EVMs, an array of peak EVMs, an array of Rhos, an array of RMS magnitude errors, and an array of RMS phase errors of the complex chips of the corrected signal corresponding to all the carriers in the ModAcc measurement. The array elements represent the result of each carrier in the measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ”result::r1”

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

• timeout (float) – This parameter specifies the 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_evm (float):

This parameter returns the array of RMS EVM values of the composite signal corresponding to the carriers. This value is expressed as a percentage.

peak_evm (float):

This parameter returns the array of peak EVM values of the composite signal corresponding to the carriers. This value is expressed as a percentage.

rho (float):

This parameter returns the array of correlation values of the received signal with the reference signal normalized by the signal power corresponding to the carriers. Valid values range from 0 to 1.0, inclusive. The maximum value of Rho is 1.0, which indicates that the received signal and reference signal are perfectly correlated.

frequency_error (float):

This parameter returns the array of frequency offset values of the composite signal corresponding to the carriers. This value is expressed in Hz.

chip_rate_error (float):

This parameter returns the array of chip rate errors of the composite signal corresponding to the carriers. This value is expressed in ppm.

rms_magnitude_error (float):

This parameter returns the array of RMS magnitude errors of the composite signal corresponding to the carriers. This value is expressed in percentage.

rms_phase_error (float):

This parameter returns the array of RMS phase error values of the composite signal corresponding to the carriers. 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 (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)

Fetches the EVM trace of a carrier for the ModAcc measurement.

Use “carrier<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 carrier number.

  Example:

  ”carrier0”

  ”result::r1/carrier0”

  You can use the build_carrier_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.

• evm (numpy.float32) – This parameter returns the EVM value. 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_iq_impairments(selector_string, timeout)

Fetches the I/Q origin offset, I/Q gain imbalance and I/Q quadrature error for a carrier in the ModAcc measurement.

Use “carrier<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 carrier number.

  Example:

  ”carrier0”

  ”result::r1/carrier0”

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

iq_origin_offset (float):

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

The I/Q origin offset is a measure of the DC component present in the I/Q signal being measured.

iq_gain_imbalance (float):

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

The I/Q gain imbalance is the ratio of the magnitude of the I component to the Q component of the I/Q signal being measured.

iq_quadrature_error (float):

This parameter returns the I/Q quadrature error of the composite signal of a carrier.

This value is expressed in degrees. Quadrature error is a measure of the error in the phase between I and Q components of the signal being measured.

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

Fetches the array of I/Q origin offsets, an array of I/Q gain imbalances, and an array of I/Q quadrature errors corresponding to all the carriers in the ModAcc measurement. The array elements represent result of each carrier in the measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ”result::r1”

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

• timeout (float) – This parameter specifies the 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:

iq_origin_offset (float):

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

The I/Q origin offset is a measure of the DC component present in the I/Q signal being measured.

iq_gain_imbalance (float):

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

The I/Q gain imbalance is the ratio of the magnitude of the I component to the Q component of the I/Q signal being measured.

iq_quadrature_error (float):

This parameter returns the array of I/Q quadrature error values of the composite signal.

This value is expressed in degrees. Quadrature error is a measure of the error in the phase between I and Q components of the signal being measured.

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)

Fetches the magnitude error trace of a carrier for the ModAcc measurement.

Use “carrier<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 carrier number.

  Example:

  ”carrier0”

  ”result::r1/carrier0”

  You can use the build_carrier_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.

• magnitude_error (numpy.float32) – This parameter returns 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_multicarrier_iq_impairments(selector_string, timeout)

Fetches the I/Q impairments for a multicarrier signal.

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:

multicarrier_iq_origin_offset (float):

This parameter returns the estimated I/Q origin offset of the multicarrier signal when the TRANSMITTER_ARCHITECTURE attribute is set to LO per Band. This value is expressed in dB. This result is useful when the LO is at the center of the multicarrier signal.

multicarrier_iq_gain_imbalance (float):

This parameter returns NaN. This parameter has been added for future use.

multicarrier_iq_quadrature_error (float):

This parameter returns NaN. This parameter has been added for future use.

error_code (int):

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

Return type:

Tuple (multicarrier_iq_origin_offset, multicarrier_iq_gain_imbalance, multicarrier_iq_quadrature_error, error_code)

fetch_number_of_detected_channels(selector_string, timeout)

Fetches the number of detected channels in a carrier for the ModAcc measurement.

Use “carrier<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 carrier number.

  Example:

  ”carrier0”

  ”result::r1/carrier0”

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

number_of_detected_channels (int):

This parameter returns the number of detected channels when you set the CHANNEL_CONFIGURATION_MODE attribute to Auto Detect. If you set the Channel Configuration Mode attribute to User Defined or Test Model, this parameter 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 (number_of_detected_channels, error_code)

fetch_number_of_detected_channels_array(selector_string, timeout)

Fetches an array of number of detected channels of all the carriers in the ModAcc measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name.

  Example:

  ”result::r1”

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

• timeout (float) – This parameter specifies the 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:

number_of_detected_channels (int):

This parameter returns the array of the number of detected channels when you set the Channel Configuration Mode attribute to Auto Detect. If you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined or Test Model, this parameter returns the array of 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 (number_of_detected_channels, error_code)

fetch_peak_active_cde(selector_string, timeout)

Fetches the peak value among the code domain errors (CDEs) of the active channels, along with the code number, spreading factor, and branch that correspond to this peak value for a carrier in the ModAcc measurement.

Use “carrier<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 carrier number.

  Example:

  ”carrier0”

  ”result::r1/carrier0”

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

peak_active_cde (float):

This parameter returns the maximum value among the active code domain errors for a carrier. This value is expressed in dB.

The active CDEs are computed by despreading the descrambled error vectors corresponding to each active channel with the appropriate active channel codes. The active CDE is defined as the ratio of the mean power of this despread error vector to the mean power of the composite reference waveform.

peak_active_cde_spreading_factor (int):

This parameter returns the spreading factor of the channel corresponding to the value of the Peak Active CDE parameter for a carrier.

peak_active_cde_code (int):

This parameter returns the spreading code of the channel corresponding to the value of the Peak Active CDE parameter for a carrier.

peak_active_cde_branch (enums.ModAccPeakActiveCdeBranch):

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

Name (Value)	Description
I (0)	Signal is modulated on the in-phase branch.
Q (1)	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_spreading_factor, peak_active_cde_code, peak_active_cde_branch, error_code)

fetch_peak_active_cde_array(selector_string, timeout)

Fetches arrays of peak CDE values among all the active channels of a carrier, and the corresponding code numbers, spreading factors, and branches of the carriers. Each element in these arrays corresponds to the peak value among the code domain errors of all the active channels in each carrier.

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:

peak_active_cde (float):

This parameter returns array of maximum values among the active code domain errors. This value is expressed in dB.

The active CDEs are computed by despreading the descrambled error vectors corresponding to each active channel with the appropriate active channel codes. The active CDE is defined as the ratio of the mean power of this despread error vector to the mean power of the composite reference waveform.

peak_active_cde_spreading_factor (int):

This parameter returns the array of spreading factors of the channel corresponding to the value of the Peak Active CDE parameter.

peak_active_cde_code (int):

This parameter returns the array of spreading codes of the channel corresponding to the value of the Peak Active CDE parameter.

peak_active_cde_branch (enums.ModAccPeakActiveCdeBranch):

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

Name (Value)	Description
I (0)	Signal is modulated on the in-phase branch.
Q (1)	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_spreading_factor, peak_active_cde_code, peak_active_cde_branch, error_code)

fetch_peak_cde(selector_string, timeout)

Fetches the peak value among the code domain errors (CDEs) obtained with a fixed spreading factor of 4, along with the code number and branch that correspond to this peak value for a carrier in the ModAcc measurement.

Use “carrier<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 carrier number.

  Example:

  ”carrier0”

  ”result::r1/carrier0”

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

peak_cde (float):

This parameter returns the maximum CDE value for a carrier in the received signal.

The CDEs are computed by despreading the descrambled error vector using a specific spreading factor. A fixed spreading factor of 4 is used.

The CDE for every code with the specific spreading factor is defined as the ratio of the mean power of the descrambled and despread error vector to the mean power of the composite reference waveform. The CDEs for both I and Q branches are computed for each code.

This value is expressed in dB.

peak_cde_code (int):

This parameter returns the spreading code corresponding to the value of the **Peak CDE ** parameter for a carrier in the received signal.

peak_cde_branch (enums.ModAccPeakCdeBranch):

This parameter returns the branch of the channel corresponding to the value of the Peak CDE parameter for a carrier in the received signal.

Name (Value)	Description
I (0)	The signal is modulated in the in-phase branch.
Q (1)	The signal is modulated in 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_code, peak_cde_branch, error_code)

fetch_peak_cde_array(selector_string, timeout)

Fetches an array of peak CDE values obtained with a fixed spreading factor of 4 for all the carriers and the corresponding code numbers and branches. Each element in these arrays corresponds to the peak value among the code domain errors in each carrier.

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:

peak_cde (float):

This parameter returns the array of maximum CDE values. This value is expressed in dB.

The CDEs are computed by despreading the descrambled error vector using a specific spreading factor. A fixed spreading factor of 4 is used.

The CDE for every code with the specific spreading factor is defined as the ratio of the mean power of the descrambled and despread error vector to the mean power of the composite reference waveform. The CDEs for both I and Q branches are computed for each code.

peak_cde_code (int):

This parameter returns the array of spreading codes corresponding to the value of the Peak CDE parameter.

peak_cde_branch (enums.ModAccPeakCdeBranch):

This parameter returns the array of branches of the channel corresponding to the value of the Peak CDE 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 (peak_cde, peak_cde_code, peak_cde_branch, error_code)

fetch_phase_error_trace(selector_string, timeout, phase_error)

Fetches the phase error trace of a carrier for the ModAcc measurement.

Use “carrier<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 carrier number.

  Example:

  ”carrier0”

  ”result::r1/carrier0”

  You can use the build_carrier_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.

• phase_error (numpy.float32) – This parameter returns an 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)

fetch_rcde(selector_string, timeout)

Returns the peak relative code domain error (RCDE) value of the active channels, along with the code number, spreading factor, and branch that correspond to this peak value for a carrier in the ModAcc measurement.

Use “carrier<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 carrier number.

  Example:

  ”carrier0”

  ”result::r1/carrier0”

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

peak_rcde (float):

This parameter returns the maximum value among the relative code domain errors (RCDEs) for all active channels for a carrier. This value is expressed in dB.

The relative CDEs are computed by despreading the descrambled error vector corresponding to each active channel with the appropriate active channel codes. The RCDE is defined as the ratio of the mean power of this despread error vector to the mean power of the corresponding reference waveform.

peak_rcde_spreading_factor (int):

This parameter returns the spreading factor of the channel corresponding to the value of the Peak RCDE parameter for a carrier.

peak_rcde_code (int):

This parameter returns the spreading code of the channel corresponding to the value of the Peak RCDE parameter for a carrier.

peak_rcde_branch (enums.ModAccPeakRcdeBranch):

This parameter returns the branch of the channel corresponding to the value of the Peak RCDE parameter for a carrier.

Name (Value)	Description
I (0)	The signal is modulated in the in-phase branch.
Q (1)	The signal is modulated in 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_rcde, peak_rcde_spreading_factor, peak_rcde_code, peak_rcde_branch, error_code)

fetch_rcde_array(selector_string, timeout)

Fetches arrays of peak relative CDE values of the active channels, of the carriers and the corresponding code numbers, spreading factors, and branches. Each element in these arrays corresponds to the peak value among the relative code domain errors of all the active channels in each carrier.

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:

peak_rcde (float):

This parameter returns the array of maximum value among the relative code domain errors (RCDEs) for all active channels. This value is expressed in dB.

The relative CDEs are computed by despreading the descrambled error vector corresponding to each active channel with the appropriate active channel codes. The RCDE is defined as the ratio of the mean power of this despread error vector to the mean power of the corresponding reference waveform.

peak_rcde_spreading_factor (int):

This parameter returns the array of spreading factors of the channel corresponding to the value of the Peak RCDE parameter.

peak_rcde_code (int):

This parameter returns the array of spreading codes of the channel corresponding to the value of the Peak RCDE parameter.

peak_rcde_branch (enums.ModAccPeakRcdeBranch):

This parameter returns the array of branches of the channel corresponding to the value of the Peak RCDE parameter.

Name (Value)	Description
I (0)	The signal is modulated in the in-phase branch.
Q (1)	The signal is modulated in 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_rcde, peak_rcde_spreading_factor, peak_rcde_code, peak_rcde_branch, error_code)

fetch_rcde_trace(selector_string, timeout)

Fetches the relative code domain errors (RCDE) trace of a carrier for the ModAcc measurement.

Use “carrier<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 carrier number.

  Example:

  ”carrier0”

  ”result::r1/carrier0”

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

rcde (float):

This parameter returns an array of RCDE values of the active 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 (rcde, error_code)

fetch_reference_waveform(selector_string, timeout, reference_waveform)

Fetches the reference waveform for the ModAcc measurement.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of result name, and carrier number.

  Example:

  ”carrier0”

  ”result::r1/carrier0”

  You can use the build_carrier_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.

• reference_waveform (numpy.complex64) – This parameter returns an array of the normalized ideal complex baseband samples, corresponding to the acquired signal. This value is expressed in volts.

Returns:

x0 (float):

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

dx (float):

This parameter returns the sample 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 of the composite signal.

This value is expressed in ppm.

Use “carrier<n>” as the selector string to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the chip rate error of the composite 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_detected_branch(selector_string)

Gets the branch of the detected channel.

If the CHANNEL_CONFIGURATION_MODE attribute is set to User Defined or Test Model, the ModAcc Results Detected Branch attribute returns the branch of the configured channel of a carrier.

Use “carrier<n>/channel<k>” as the selector string to read this result.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccDetectedBranch):

Returns the branch of the detected 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_modulation_type(selector_string)

Gets the modulation type of the detected channel.

If the CHANNEL_CONFIGURATION_MODE attribute is set to User Defined or Test Model, the ModAcc Results Detected Mod Type attribute returns the modulation type of the configured channel of a carrier.

Use “carrier<n>/channel<k>” as the selector string to read this result.

Name (Value)	Description
BPSK/QPSK (0)	The modulation type is BPSK.
4PAM/16QAM (1)	The modulation type is 4-PAM.
64QAM (2)	The modulation type is 64-QAM.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccDetectedModulationType):

Returns the modulation type of the detected 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_spreading_code(selector_string)

Gets the spreading code of the detected channel.

If you set the CHANNEL_CONFIGURATION_MODE attribute to User Defined or Test Model, the ModAcc Results Detected Spreading Code attribute returns the spreading code of the configured channel of a carrier.

Use “carrier<n>/channel<k>” as the selector string to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the spreading code of the detected 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_spreading_factor(selector_string)

Gets the spreading factor of the detected channel.

If the CHANNEL_CONFIGURATION_MODE attribute is set to User Defined or Test Model, the ModAcc Results Detected Spreading Factor attribute returns the spreading factor of the configured channel of a carrier.

Use “carrier<n>/channel<k>” as the selector string to read this result.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the spreading factor of the detected 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_dpch_timing_offset(selector_string)

The timing offset of the selected channel.

Use “carrier<n>” as the selector string to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

The timing offset of the selected 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 offset of the composite signal.

This value is expressed in Hz.

Use “carrier<n>” as the selector string to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the frequency offset of the composite 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_iq_gain_imbalance(selector_string)

Gets the I/Q gain imbalance of the composite signal of a carrier. This value is expressed in dB. The I/Q gain imbalance is the ratio of the magnitude of the I component to the Q component of the I/Q signal being measured.

Use “carrier<n>” as the selector string to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the I/Q gain imbalance of the composite signal of a carrier. This value is expressed in dB. The I/Q gain imbalance is the ratio of the magnitude of the I component to the Q component of the I/Q signal being measured.

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 of a carrier. This value is expressed in dB.

The I/Q origin offset is a measure of the DC component present in the I/Q signal being measured.

Use “carrier<n>” as the selector string to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the I/Q origin offset of the composite signal of a carrier. 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 of a carrier. This value is expressed in degrees. Quadrature error is a measure of the error in the phase between I and Q components of the signal being measured.

Use “carrier<n>” as the selector string to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the I/Q quadrature error of the composite signal of a carrier. This value is expressed in degrees. Quadrature error is a measure of the error in the phase between I and Q components of the signal being measured.

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

Gets the estimated I/Q origin offset of the multicarrier signal when the TRANSMITTER_ARCHITECTURE attribute is set to LO per Band. 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 and result instances. Refer to the Selector String topic for information about the string syntax for named signals and named results.

This result is useful when the LO is at the center of the multicarrier signal.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the estimated I/Q origin offset of the multicarrier signal when the TRANSMITTER_ARCHITECTURE attribute is set to LO per Band. 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_number_of_detected_channels(selector_string)

Gets the number of detected channels when you set the CHANNEL_CONFIGURATION_MODE attribute to Auto Detect. If you set the Channel Configuration Mode attribute to User Defined or Test Model, this attribute returns the number of configured channels.

Use “carrier<n>” as the selector string to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the number of detected channels when you set the CHANNEL_CONFIGURATION_MODE attribute to Auto Detect. If you set the Channel Configuration Mode attribute to User Defined or Test Model, this 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 active code domain errors (CDEs) for a carrier. This value is expressed in dB.

The active CDEs are computed by despreading the descrambled error vectors corresponding to each active channel with the appropriate active channel codes. The active CDE is defined as the ratio of the mean power of this despread error vector to the mean power of the composite reference waveform.

Use “carrier<n>” as the selector string to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the maximum value among the active code domain errors (CDEs) for a carrier. 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_peak_active_cde_branch(selector_string)

Gets the branch of the channel corresponding to the value of the MODACC_RESULTS_PEAK_ACTIVE_CDE attribute for a carrier.

Use “carrier<n>” as the selector string to read this attribute.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccPeakActiveCdeBranch):

Returns the branch of the channel corresponding to the value of the MODACC_RESULTS_PEAK_ACTIVE_CDE attribute for a carrier.

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

Gets the spreading code of the channel corresponding to the value of the MODACC_RESULTS_PEAK_ACTIVE_CDE attribute for a carrier.

Use “carrier<n>” as the selector string to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the spreading code of the channel corresponding to the value of the MODACC_RESULTS_PEAK_ACTIVE_CDE attribute for a carrier.

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

Gets the spreading factor of the channel corresponding to the value of the MODACC_RESULTS_PEAK_ACTIVE_CDE attribute for a carrier.

Use “carrier<n>” as the selector string to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the spreading factor of the channel corresponding to the value of the MODACC_RESULTS_PEAK_ACTIVE_CDE attribute for a carrier.

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 code domain error value (CDE).

This value is expressed in dB.

The CDEs are computed by despreading the descrambled error vector using a specific spreading factor. A fixed spreading factor of 4 is used.

The CDE for every code with the specific spreading factor is defined as the ratio of the mean power of the descrambled and despread error vector to the mean power of the composite reference waveform. The CDEs for both I and Q branches are computed for each code.

Use “carrier<n>” as the selector string to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the maximum code domain error value (CDE).

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 of the MODACC_RESULTS_PEAK_CDE attribute.

Use “carrier<n>” as the selector string to read this attribute.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccPeakCdeBranch):

Returns the branch corresponding to the value of the MODACC_RESULTS_PEAK_CDE 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_cde_code(selector_string)

Gets the spreading code corresponding to the value of the MODACC_RESULTS_PEAK_CDE attribute.

Use “carrier<n>” as the selector string to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the spreading code corresponding to the value of the MODACC_RESULTS_PEAK_CDE 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_evm(selector_string)

Gets the peak EVM of the composite signal.

This value is expressed as a percentage.

Use “carrier<n>” as the selector string to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

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

Gets the maximum value among the relative code domain errors (RCDEs) for all active channels for a carrier. This value is expressed in dB.

The relative CDEs are computed by despreading the descrambled error vector corresponding to each active channel with the appropriate active channel codes. The RCDE is defined as the ratio of the mean power of this despread error vector to the mean power of the corresponding reference waveform.

Use “carrier<n>” as the selector string to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the maximum value among the relative code domain errors (RCDEs) for all active channels for a carrier. 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_peak_rcde_branch(selector_string)

Gets the branch of the channel corresponding to the value of the MODACC_RESULTS_PEAK_RCDE attribute for a carrier.

Use “carrier<n>” as the selector string to read this attribute.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccPeakRcdeBranch):

Returns the branch of the channel corresponding to the value of the MODACC_RESULTS_PEAK_RCDE attribute for a carrier.

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

Gets the spreading code of the channel corresponding to the value of the MODACC_RESULTS_PEAK_RCDE attribute for a carrier.

Use “carrier<n>” as the selector string to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the spreading code of the channel corresponding to the value of the MODACC_RESULTS_PEAK_RCDE attribute for a carrier.

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

Gets the spreading factor of the channel corresponding to the value of the MODACC_RESULTS_PEAK_RCDE attribute for a carrier.

Use “carrier<n>” as the selector string to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Returns the spreading factor of the channel corresponding to the value of the MODACC_RESULTS_PEAK_RCDE attribute for a carrier.

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

The primary SCH power for a BS UUT.

Use “carrier<n>” as the selector string to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

The primary SCH power for a BS UUT.

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 figure of merit used to characterize the modulation accuracy of the composite code domain signal. It refers to the fraction of the total power that can be correlated to the correct active channels in the detected reference signal.

Use “carrier<n>” as the selector string to read this attribute.

You can calculate the value of Rho using the following equation:

Rho = Power correctly correlated to active channels / Total power

A Rho value of 1 indicates that all the transmitted power is correlated to the correct active channels and there is no power in the inactive (undesired) channels. Any energy correlated to the inactive channels degrades modulation quality and results in a value of Rho less than 1. Valid values are 0.0 to 1.0, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the figure of merit used to characterize the modulation accuracy of the composite code domain signal. It refers to the fraction of the total power that can be correlated to the correct active channels in the detected reference 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_rms_evm(selector_string)

Gets the RMS EVM of the composite signal.

This value is expressed as a percentage.

Use “carrier<n>” as the selector string to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

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

Gets the RMS magnitude error of the composite signal.

This value is expressed as a percentage.

Use “carrier<n>” as the selector string to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

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

Gets the RMS phase error of the composite signal.

This value is expressed in degrees.

Use “carrier<n>” as the selector string to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

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

The secondary SCH power for a BS UUT.

Use “carrier<n>” as the selector string to read this attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

The secondary SCH power for a BS UUT.

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)