CdaConfiguration

Provides methods to configure the Cda measurement.

class nirfmxtdscdma.cda_configuration.CdaConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the Cda measurement.

configure_averaging(selector_string, averaging_enabled, averaging_count)[source]

Configures averaging for the CDA measurement.

Parameters:

  • selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

  • averaging_enabled (enums.CdaAveragingEnabled, int) –

    This parameter specifies whether to enable averaging for the CDA measurement. The default value is False.

    Name (value)

    Description

    False (0)

    The measurement is performed on a single acquisition.

    True (1)

    The CDA measurement uses the value of the Averaging Count parameter as the number of acquisitions over which the CDA measurement is averaged.

  • averaging_count (int) – This parameter specifies the number of acquisitions used for averaging when you set the Averaging Enabled parameter to True. The default value is 10.

Returns:

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

Return type:

int

configure_measurement_channel(selector_string, spreading_factor, channelization_code)[source]

Configures the physical channel to be analyzed using the Spreading Factor parameter and the Channelization Code parameter.

Parameters:

  • selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

  • spreading_factor (int) – This parameter specifies the base spreading factor for code domain power (CDP) analysis. The default value is 16.

  • channelization_code (int) – This parameter specifies the channelization code of the code domain analysis (CDA) measurement channel. The default value is 1. The valid values are 1 to 16.

Returns:

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

Return type:

int

configure_power_unit(selector_string, power_unit)[source]

Configures the unit of measurement for the measurement results.

Parameters:

  • selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

  • power_unit (enums.CdaPowerUnit, int) –

    This parameter specifies the measurement unit of the measured code domain power results. The default value is dB.

    Name (value)

    Description

    dB (0)

    The measurement unit for code domain power results is dB.

    dBm (1)

    The measurement unit for code domain power results is dBm.

Returns:

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

Return type:

int

configure_synchronization_mode_and_offset(selector_string, synchronization_mode, measurement_offset)[source]

Configures the synchronization mode and the measurement offset for the code domain analysis (CDA) measurement. You can select a specific time slot for the measurement using this method.

Parameters:

  • selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.

  • synchronization_mode (enums.CdaSynchronizationMode, int) –

    This parameter specifies the synchronization mode for the CDA measurement. Currently, only the Slot mode is supported.

    Name (value)

    Description

    Slot (0)

    The measurement uses slot synchronization mode. The slot boundary in the acquired signal is detected, and the measurement is performed over one slot, starting from the boundary specified by the MODACC_MEASUREMENT_OFFSET attribute.

  • measurement_offset (int) – This parameter specifies the measurement offset to skip from the synchronization boundary. This value is expressed in slots. The synchronization boundary is specified by the Synchronization Mode parameter. The default value is 0.

Returns:

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

Return type:

int

get_all_traces_enabled(selector_string)[source]

Gets whether to enable the traces to be stored and retrieved after performing the code domain analysis (CDA) measurement.

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

The default value is FALSE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (bool):

Specifies whether to enable the traces to be stored and retrieved after performing the code domain analysis (CDA) measurement.

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_averaging_count(selector_string)[source]

Gets the number of acquisitions used for averaging when you set the CDA_AVERAGING_ENABLED attribute to True.

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

The default value is 10.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of acquisitions used for averaging when you set the CDA_AVERAGING_ENABLED attribute to True.

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_averaging_enabled(selector_string)[source]

Gets whether to enable averaging for the code domain analysis (CDA) measurement.

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

The default value is False.

Name (Value)

Description

False (0)

The measurement is performed on a single acquisition.

True (1)

The CDA measurement uses the value of the CDA Averaging Count attribute as the number of acquisitions over which the CDA measurement is averaged.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CdaAveragingEnabled):

Specifies whether to enable averaging for the code domain analysis (CDA) measurement.

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_base_spreading_factor(selector_string)[source]

Gets the base spreading factor for code domain analysis.

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

The default value is 16. The valid values are 1, 2, 4, 8, and 16.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the base spreading factor for code domain analysis.

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_removal_enabled(selector_string)[source]

Gets whether to remove the I/Q gain imbalance before the code domain analysis (CDA) measurement.

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

The default value is False.

Name (Value)

Description

False (0)

The I/Q gain imbalance is not removed before the CDA measurement.

True (1)

The I/Q gain imbalance is removed before the CDA measurement.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CdaIQGainImbalanceRemovalEnabled):

Specifies whether to remove the I/Q gain imbalance before the code domain analysis (CDA) measurement.

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_offset_removal_enabled(selector_string)[source]

Gets whether to remove the I/Q offset before the code domain analysis (CDA) measurement.

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

The default value is False.

Name (Value)

Description

False (0)

The I/Q offset is not removed before the CDA measurement.

True (1)

The I/Q offset is removed before the CDA measurement.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CdaIQOffsetRemovalEnabled):

Specifies whether to remove the I/Q offset before the code domain analysis (CDA) measurement.

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_removal_enabled(selector_string)[source]

Gets whether to remove the I/Q quadrature error before the code domain analysis (CDA) measurement.

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

The default value is False.

Name (Value)

Description

False (0)

The I/Q quadrature error is not removed before the CDA measurement.

True (1)

The I/Q quadrature error is removed before the CDA measurement.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CdaIQQuadratureErrorRemovalEnabled):

Specifies whether to remove the I/Q quadrature error before the code domain analysis (CDA) measurement.

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_measurement_channel_channelization_code(selector_string)[source]

Gets the channelization code of the code domain analysis (CDA) measurement channel.

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

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the channelization code of the code domain analysis (CDA) 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 (attr_val, error_code)

get_measurement_channel_spreading_factor(selector_string)[source]

Gets the spreading factor of the channel on which to perform the code domain analysis (CDA) measurement.

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

The default value is 16. The valid values are 1, 2, 4, 8, and 16.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the spreading factor of the channel on which to perform the code domain analysis (CDA) measurement.

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_measurement_enabled(selector_string)[source]

Gets whether to enable the code domain analysis (CDA) measurement.

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

The default value is FALSE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (bool):

Specifies whether to enable the code domain analysis (CDA) measurement.

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_measurement_offset(selector_string)[source]

Gets the measurement offset to skip from the synchronization boundary. This value is expressed in slots. The synchronization boundary is specified by the CDA_SYNCHRONIZATION_MODE attribute.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the measurement offset to skip from the synchronization boundary. This value is expressed in slots. The synchronization boundary is specified by the CDA_SYNCHRONIZATION_MODE 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_number_of_analysis_threads(selector_string)[source]

Gets the maximum number of threads used for parallelism for the code domain analysis (CDA) measurement.

The number of threads can range from 1 to the number of physical cores. The number of threads you set may not be used in calculations. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations.

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

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the maximum number of threads used for parallelism for the code domain analysis (CDA) measurement.

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_power_unit(selector_string)[source]

Gets the measurement unit of the code domain power (CDP) results.

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

The default value is dB.

Name (Value)

Description

dB (0)

The measurement unit for CDP results is dB.

dBm (1)

The measurement unit for CDP results is dBm.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CdaPowerUnit):

Specifies the measurement unit of the code domain power (CDP) results.

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_rrc_filter_enabled(selector_string)[source]

Gets whether to enable the RRC filter.

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

The default value is True.

Name (Value)

Description

False (0)

Disables the RRC filter in the measurement.

True (1)

Enables the RRC filter in the measurement.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CdaRrcFilterEnabled):

Specifies whether to enable the RRC filter.

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_spectrum_inverted(selector_string)[source]

Gets whether the spectrum of the signal is inverted.

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

The default value is False.

Name (Value)

Description

False (0)

The spectrum is not inverted.

True (1)

The spectrum is inverted.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CdaSpectrumInverted):

Specifies whether the spectrum of the signal is inverted.

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_synchronization_mode(selector_string)[source]

Gets the synchronization mode for the code domain analysis (CDA) measurement. Currently, only the Slot mode is supported.

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

Name (Value)

Description

Slot (0)

The measurement uses slot synchronization mode. The slot boundary in the acquired signal is detected, and the measurement is performed over one slot, starting from the boundary specified by the CDA Meas Offset attribute.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CdaSynchronizationMode):

Specifies the synchronization mode for the code domain analysis (CDA) measurement. Currently, only the Slot mode is supported.

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)

set_all_traces_enabled(selector_string, value)[source]

Sets whether to enable the traces to be stored and retrieved after performing the code domain analysis (CDA) measurement.

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

The default value is FALSE.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (bool) – Specifies whether to enable the traces to be stored and retrieved after performing the code domain analysis (CDA) measurement.

Returns:

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

Return type:

int

set_averaging_count(selector_string, value)[source]

Sets the number of acquisitions used for averaging when you set the CDA_AVERAGING_ENABLED attribute to True.

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

The default value is 10.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the number of acquisitions used for averaging when you set the CDA_AVERAGING_ENABLED attribute to True.

Returns:

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

Return type:

int

set_averaging_enabled(selector_string, value)[source]

Sets whether to enable averaging for the code domain analysis (CDA) measurement.

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

The default value is False.

Name (Value)

Description

False (0)

The measurement is performed on a single acquisition.

True (1)

The CDA measurement uses the value of the CDA Averaging Count attribute as the number of acquisitions over which the CDA measurement is averaged.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.CdaAveragingEnabled, int) – Specifies whether to enable averaging for the code domain analysis (CDA) measurement.

Returns:

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

Return type:

int

set_base_spreading_factor(selector_string, value)[source]

Sets the base spreading factor for code domain analysis.

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

The default value is 16. The valid values are 1, 2, 4, 8, and 16.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the base spreading factor for code domain analysis.

Returns:

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

Return type:

int

set_iq_gain_imbalance_removal_enabled(selector_string, value)[source]

Sets whether to remove the I/Q gain imbalance before the code domain analysis (CDA) measurement.

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

The default value is False.

Name (Value)

Description

False (0)

The I/Q gain imbalance is not removed before the CDA measurement.

True (1)

The I/Q gain imbalance is removed before the CDA measurement.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.CdaIQGainImbalanceRemovalEnabled, int) – Specifies whether to remove the I/Q gain imbalance before the code domain analysis (CDA) measurement.

Returns:

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

Return type:

int

set_iq_offset_removal_enabled(selector_string, value)[source]

Sets whether to remove the I/Q offset before the code domain analysis (CDA) measurement.

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

The default value is False.

Name (Value)

Description

False (0)

The I/Q offset is not removed before the CDA measurement.

True (1)

The I/Q offset is removed before the CDA measurement.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.CdaIQOffsetRemovalEnabled, int) – Specifies whether to remove the I/Q offset before the code domain analysis (CDA) measurement.

Returns:

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

Return type:

int

set_iq_quadrature_error_removal_enabled(selector_string, value)[source]

Sets whether to remove the I/Q quadrature error before the code domain analysis (CDA) measurement.

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

The default value is False.

Name (Value)

Description

False (0)

The I/Q quadrature error is not removed before the CDA measurement.

True (1)

The I/Q quadrature error is removed before the CDA measurement.
Parameters:
Returns:

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

Return type:

int

set_measurement_channel_channelization_code(selector_string, value)[source]

Sets the channelization code of the code domain analysis (CDA) measurement channel.

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

The default value is 1.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the channelization code of the code domain analysis (CDA) measurement channel.

Returns:

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

Return type:

int

set_measurement_channel_spreading_factor(selector_string, value)[source]

Sets the spreading factor of the channel on which to perform the code domain analysis (CDA) measurement.

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

The default value is 16. The valid values are 1, 2, 4, 8, and 16.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the spreading factor of the channel on which to perform the code domain analysis (CDA) measurement.

Returns:

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

Return type:

int

set_measurement_enabled(selector_string, value)[source]

Sets whether to enable the code domain analysis (CDA) measurement.

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

The default value is FALSE.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (bool) – Specifies whether to enable the code domain analysis (CDA) measurement.

Returns:

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

Return type:

int

set_measurement_offset(selector_string, value)[source]

Sets the measurement offset to skip from the synchronization boundary. This value is expressed in slots. The synchronization boundary is specified by the CDA_SYNCHRONIZATION_MODE attribute.

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

The default value is 0.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the measurement offset to skip from the synchronization boundary. This value is expressed in slots. The synchronization boundary is specified by the CDA_SYNCHRONIZATION_MODE attribute.

Returns:

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

Return type:

int

set_number_of_analysis_threads(selector_string, value)[source]

Sets the maximum number of threads used for parallelism for the code domain analysis (CDA) measurement.

The number of threads can range from 1 to the number of physical cores. The number of threads you set may not be used in calculations. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations.

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

The default value is 1.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the maximum number of threads used for parallelism for the code domain analysis (CDA) measurement.

Returns:

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

Return type:

int

set_power_unit(selector_string, value)[source]

Sets the measurement unit of the code domain power (CDP) results.

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

The default value is dB.

Name (Value)

Description

dB (0)

The measurement unit for CDP results is dB.

dBm (1)

The measurement unit for CDP results is dBm.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.CdaPowerUnit, int) – Specifies the measurement unit of the code domain power (CDP) results.

Returns:

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

Return type:

int

set_rrc_filter_enabled(selector_string, value)[source]

Sets whether to enable the RRC filter.

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

The default value is True.

Name (Value)

Description

False (0)

Disables the RRC filter in the measurement.

True (1)

Enables the RRC filter in the measurement.
Parameters:
Returns:

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

Return type:

int

set_spectrum_inverted(selector_string, value)[source]

Sets whether the spectrum of the signal is inverted.

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

The default value is False.

Name (Value)

Description

False (0)

The spectrum is not inverted.

True (1)

The spectrum is inverted.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.CdaSpectrumInverted, int) – Specifies whether the spectrum of the signal is inverted.

Returns:

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

Return type:

int

set_synchronization_mode(selector_string, value)[source]

Sets the synchronization mode for the code domain analysis (CDA) measurement. Currently, only the Slot mode is supported.

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

Name (Value)

Description

Slot (0)

The measurement uses slot synchronization mode. The slot boundary in the acquired signal is detected, and the measurement is performed over one slot, starting from the boundary specified by the CDA Meas Offset attribute.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.CdaSynchronizationMode, int) – Specifies the synchronization mode for the code domain analysis (CDA) measurement. Currently, only the Slot mode is supported.

Returns:

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

Return type:

int