CdaConfiguration

Provides methods to configure the Cda measurement.

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

Bases: object

Provides methods to configure the Cda measurement.

configure_measurement_channel(selector_string, walsh_code_length, walsh_code_number, branch)[source]

Configures the spreading factor, spreading code, modulation type, and branch of the channel to be measured.

Parameters:

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

  • walsh_code_length (int) – This parameter specifies the Walsh code length of a channel subject to channel specific analysis. The default value is 64. The valid values are 2, 4, 8, 16, 32, and 64.

  • walsh_code_number (int) – This parameter specifies the Walsh code number of a channel subject to channel specific analysis.

  • branch (enums.CdaMeasurementChannelBranch, int) –

    This parameter specifies the Walsh branch of a channel subject to channel specific analysis. The default value is I.

    Name (value)

    Description

    I (0)

    Specifies the in-phase branch.

    Q (1)

    Specifies the quadrature branch.

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 Power Unit parameter for the code domain power results, except for the Total Power parameter.

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. This value is expressed in dB/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_interval(selector_string, synchronization_mode, measurement_offset, measurement_length)[source]

Configures the Synchronization Mode, Measurement Offset, and Measurement Length parameters for the code domain analysis (CDA) measurement.

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 whether the measurement is performed from the frame, slot, or symbol boundary.

    The default value is Slot.

    Name (value)

    Description

    Frame (0)

    The frame boundary is detected, and the measurement is performed over the number of slots specified by the Measurement Length parameter starting at the Measurement Offset slots from the frame boundary.

    Slot (1)

    The slot boundary is detected, and the measurement is performed over the number of slots specified by the Measurement Length parameter starting at the Measurement Offset slots from the slot boundary.

    Arbitrary (2)

    The symbol boundary is detected, and the measurement is performed over the number of slots specified by the Measurement Length parameter starting at the Measurement Offset slots from the symbol boundary.

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

  • measurement_length (int) –

    This parameter specifies the duration of code domain measurement. This value is expressed in slots.

    The default value is 0. The valid values are 1 to 16, inclusive.

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).

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).

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 used to calculate the code domain power traces.

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 64. The valid values are 2, 4, 8, 16, 32, and 64.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the base spreading factor used to calculate the code domain power traces.

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)

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

True (1)

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

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

True (1)

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

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

True (1)

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

Gets the branch of a channel subject to channel specific 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 I.

Name (Value)

Description

I (0)

Specifies the in-phase branch.

Q (1)

Specifies the quadrature branch.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CdaMeasurementChannelBranch):

Specifies the branch of a channel subject to channel specific 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_measurement_channel_walsh_code_length(selector_string)[source]

Gets the Walsh code length of a channel subject to channel specific 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 64. The valid values are 2, 4, 8, 16, 32, and 64.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the Walsh code length of a channel subject to channel specific 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_measurement_channel_walsh_code_number(selector_string)[source]

Gets the Walsh code number of a channel subject to channel specific 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 0. The valid values are 0 to 63, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the Walsh code number of a channel subject to channel specific 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_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_length(selector_string)[source]

Gets the duration of code domain measurement. This value is expressed in slots.

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. The valid values are 1 to 16, inclusive. The sum of the CDA measurement offset and the CDA measurement length must be less than or equal to 16.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the duration of code domain measurement. This value is expressed in slots.

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. The synchronization boundary is specified by the CDA_SYNCHRONIZATION_MODE attribute. This value is expressed in slots.

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. The valid values are 1 to 15, inclusive. The sum of the CDA measurement offset and the CDA measurement length must be less than or equal to 16.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

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

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 measured code domain power 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 CDA measurement results are reported in dB.

dBm (1)

The CDA measurement results are reported in dBm.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CdaPowerUnit):

Specifies the measurement unit of the measured code domain power 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_receive_filter_enabled(selector_string)[source]

Gets whether to enable the received filter for the code domain analysis (CDA) measurement. Use this attribute to disable the filter, if the received signal is already filtered.

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 receive filtering for the CDA measurement.

True (1)

Enables receive filtering for the CDA measurement.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CdaReceiveFilterEnabled):

Specifies whether to enable the received filter for the code domain analysis (CDA) measurement. Use this attribute to disable the filter, if the received signal is already filtered.

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 measured spectrum is normal.

True (1)

The measured 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 whether the measurement is performed from the frame, slot, or symbol boundary.

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 Slot.

Name (Value)

Description

Frame (0)

The frame boundary is detected, and the measurement is performed over the number of slots specified by the CDA Meas Length attribute starting at the CDA measurement offset slots from the frame boundary.

Slot (1)

The slot boundary is detected, and the measurement is performed over the number of slots specified by the CDA Meas Length attribute starting at the CDA measurement offset slots from the slot boundary.

Arbitrary (2)

The symbol boundary is detected, and the measurement is performed over the number of slots specified by the CDA Meas Length attribute starting at the CDA measurement offset slots from the symbol boundary.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.CdaSynchronizationMode):

Specifies whether the measurement is performed from the frame, slot, or symbol boundary.

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).

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).

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 used to calculate the code domain power traces.

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 64. The valid values are 2, 4, 8, 16, 32, and 64.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the base spreading factor used to calculate the code domain power traces.

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)

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

True (1)

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

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

True (1)

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

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

True (1)

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_branch(selector_string, value)[source]

Sets the branch of a channel subject to channel specific 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 I.

Name (Value)

Description

I (0)

Specifies the in-phase branch.

Q (1)

Specifies the quadrature branch.
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_walsh_code_length(selector_string, value)[source]

Sets the Walsh code length of a channel subject to channel specific 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 64. The valid values are 2, 4, 8, 16, 32, and 64.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the Walsh code length of a channel subject to channel specific analysis.

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_walsh_code_number(selector_string, value)[source]

Sets the Walsh code number of a channel subject to channel specific 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 0. The valid values are 0 to 63, inclusive.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the Walsh code number of a channel subject to channel specific analysis.

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_length(selector_string, value)[source]

Sets the duration of code domain measurement. This value is expressed in slots.

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. The valid values are 1 to 16, inclusive. The sum of the CDA measurement offset and the CDA measurement length must be less than or equal to 16.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the duration of code domain measurement. This value is expressed in slots.

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. The synchronization boundary is specified by the CDA_SYNCHRONIZATION_MODE attribute. This value is expressed in slots.

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. The valid values are 1 to 15, inclusive. The sum of the CDA measurement offset and the CDA measurement length must be less than or equal to 16.

Parameters:

  • selector_string (string) – Pass an empty string.

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

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 measured code domain power 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 CDA measurement results are reported in dB.

dBm (1)

The CDA measurement results are reported in dBm.
Parameters:

  • selector_string (string) – Pass an empty string.

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

Returns:

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

Return type:

int

set_receive_filter_enabled(selector_string, value)[source]

Sets whether to enable the received filter for the code domain analysis (CDA) measurement. Use this attribute to disable the filter, if the received signal is already filtered.

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 receive filtering for the CDA measurement.

True (1)

Enables receive filtering for the CDA measurement.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.CdaReceiveFilterEnabled, int) – Specifies whether to enable the received filter for the code domain analysis (CDA) measurement. Use this attribute to disable the filter, if the received signal is already filtered.

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 measured spectrum is normal.

True (1)

The measured 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 whether the measurement is performed from the frame, slot, or symbol boundary.

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 Slot.

Name (Value)

Description

Frame (0)

The frame boundary is detected, and the measurement is performed over the number of slots specified by the CDA Meas Length attribute starting at the CDA measurement offset slots from the frame boundary.

Slot (1)

The slot boundary is detected, and the measurement is performed over the number of slots specified by the CDA Meas Length attribute starting at the CDA measurement offset slots from the slot boundary.

Arbitrary (2)

The symbol boundary is detected, and the measurement is performed over the number of slots specified by the CDA Meas Length attribute starting at the CDA measurement offset slots from the symbol boundary.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.CdaSynchronizationMode, int) – Specifies whether the measurement is performed from the frame, slot, or symbol boundary.

Returns:

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

Return type:

int