ModAccConfiguration

Provides methods to configure the ModAcc measurement.

class nirfmxtdscdma.modacc_configuration.ModAccConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the ModAcc measurement.

configure_averaging(selector_string, averaging_enabled, averaging_count)[source]

Configures averaging for the ModAcc 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.ModAccAveragingEnabled, int) –

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

    Name (value)

    Description

    False (0)

    Disables averaging for the ModAcc measurement.

    True (1)

    The ModAcc measurement uses the Averaging Count parameter as the number of acquisitions over which the ModAcc 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_slot_type(selector_string, slot_type)[source]

Configures the type of the Time Slot for ModAcc analysis.

Parameters:

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

  • slot_type (enums.ModAccSlotType, int) –

    This parameter specifies the type of the Time Slot for ModAcc analysis. The default value is Traffic.

    Name (value)

    Description

    Traffic (0)

    The measurement is performed on the traffic time slot. The composite, data, and midamble ModAcc results are obtained when you select this slot type.

    Pilot (1)

    The measurement is performed on the pilot time slot. The pilot ModAcc results are obtained when you select this slot type.

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 for ModAcc analysis.

Parameters:

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

  • synchronization_mode (enums.ModAccSynchronizationMode, int) –

    This parameter specifies the synchronization mode for the ModAcc measurement. The default value is Slot.

    Name (value)

    Description

    Slot (0)

    The measurement uses the slot synchronization mode. The first slot boundary in the acquired signal is detected, and the measurement is performed over the number of slots specified by the Measurement Length parameter, starting at the offset specified by the Measurement Offset parameter. If you set the TRIGGER_TYPE attribute to Digital Edge, you should provide the trigger at the start of the slot from which the Measurement Offset parameter should be considered. If you set the Trigger Type attribute to IQ Power Edge, it is required that the received signal has either one traffic time slot or contiguous traffic time slots. Additionally, for this trigger type, the traffic time slot(s) in the received signal should be contiguous with the pilot time slot, if the pilot time slot is present.

    Subframe (1)

    The measurement uses the subframe synchronization mode. The first subframe boundary in the acquired signal is detected, and the measurement is performed over the number of slots specified by the Measurement Length parameter, starting at the offset from the boundary specified by the Measurement Offset parameter. If you set the Trigger Type attribute to Digital Edge, you should provide the trigger at the start of the subframe. If you set the Trigger Type attribute to IQ Power Edge, it is required that the received signal has either one traffic time slot or contiguous traffic time slots. Additionally, the traffic time slot should be contiguous with the active pilot slot.

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

  • measurement_length (int) – This parameter specifies the duration of the ModAcc measurement. The default value is 1.

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 ModAcc 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 ModAcc 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 MODACC_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 MODACC_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 ModAcc 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 ModAcc measurement uses the value of the ModAcc Averaging Count attribute as the number of acquisitions over which the ModAcc measurement is averaged.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccAveragingEnabled):

Specifies whether to enable averaging for the ModAcc 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_gain_imbalance_removal_enabled(selector_string)[source]

Gets whether to remove the I/Q gain imbalance before the ModAcc 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 ModAcc measurement.

True (1)

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

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccIQGainImbalanceRemovalEnabled):

Specifies whether to remove the I/Q gain imbalance before the ModAcc 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 ModAcc 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 ModAcc measurement.

True (1)

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

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccIQOffsetRemovalEnabled):

Specifies whether to remove the I/Q offset before the ModAcc 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 ModAcc 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 ModAcc measurement.

True (1)

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

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccIQQuadratureErrorRemovalEnabled):

Specifies whether to remove the I/Q quadrature error before the ModAcc 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 ModAcc 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 ModAcc 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 measurement length for the ModAcc measurement. This value is expressed in traffic 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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the measurement length for the ModAcc measurement. This value is expressed in traffic 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 that is skipped by the ModAcc measurement from the synchronization boundary. This value is expressed in traffic slots. The synchronization boundary is specified by the MODACC_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 that is skipped by the ModAcc measurement from the synchronization boundary. This value is expressed in traffic slots. The synchronization boundary is specified by the MODACC_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_rrc_filter_enabled(selector_string)[source]

Gets whether to enable the RRC filter in the ModAcc measurement. Use this attribute to disable the filter if the received signal is already RRC-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 the RRC filter in the ModAcc measurement.

True (1)

Enables the RRC filter in the ModAcc measurement.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccRrcFilterEnabled):

Specifies whether to enable the RRC filter in the ModAcc measurement. Use this attribute to disable the filter if the received signal is already RRC-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_slot_type(selector_string)[source]

Gets the type of the time slot for the ModAcc 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 Traffic.

Name (Value)

Description

Traffic (0)

The measurement is performed on the traffic time slot. The composite, data, and midamble ModAcc results are obtained when you select this slot type.

Pilot (1)

The measurement is performed on the pilot time slot. The pilot ModAcc results are obtained when you select this slot type.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccSlotType):

Specifies the type of the time slot for the ModAcc 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_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 not inverted.

True (1)

The measured spectrum is inverted.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccSpectrumInverted):

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

Name (Value)

Description

Slot (0)

The measurement uses the slot synchronization mode. The slot boundary in the acquired signal is detected, and the measurement is performed over the number of slots specified by the ModAcc Meas Length attribute, starting at the offset from the boundary specified by the ModAcc Meas Offset attribute.

If you set the Trigger Type attribute to Digital Edge, you should provide the trigger at the start of the slot from which the ModAcc Meas Offset attribute should be considered. If you set the Trigger Type attribute to IQ Power Edge, it is required that the received signal has either one traffic time slot or contiguous traffic time slots. Additionally, for this trigger type, the traffic time slot(s) in the received signal should be contiguous with the pilot time slot, if the pilot time slot is present.

Subframe (1)

The measurement uses the subframe synchronization mode. The first subframe boundary in the acquired signal is detected, and the measurement is performed over the number of slots specified by the ModAcc Meas Length attribute, starting at the offset from the boundary specified by the ModAcc Meas Offset attribute.

If you set the Trigger Type attribute to Digital Edge, you should provide the trigger at the start of the subframe. If you set the Trigger Type attribute to IQ Power Edge, it is required that the received signal has either one traffic time slot or contiguous traffic time slots. Additionally, the traffic time slot should be contiguous with the active pilot time slot.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccSynchronizationMode):

Specifies the synchronization mode for the ModAcc 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)

set_all_traces_enabled(selector_string, value)[source]

Sets whether to enable the traces to be stored and retrieved after performing the ModAcc 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 ModAcc 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 MODACC_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 MODACC_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 ModAcc 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 ModAcc measurement uses the value of the ModAcc Averaging Count attribute as the number of acquisitions over which the ModAcc measurement is averaged.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccAveragingEnabled, int) – Specifies whether to enable averaging for the ModAcc 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_gain_imbalance_removal_enabled(selector_string, value)[source]

Sets whether to remove the I/Q gain imbalance before the ModAcc 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 ModAcc measurement.

True (1)

The I/Q gain imbalance is removed before the ModAcc 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_iq_offset_removal_enabled(selector_string, value)[source]

Sets whether to remove the I/Q offset before the ModAcc 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 ModAcc measurement.

True (1)

The I/Q offset is removed before the ModAcc 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_iq_quadrature_error_removal_enabled(selector_string, value)[source]

Sets whether to remove the I/Q quadrature error before the ModAcc 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 ModAcc measurement.

True (1)

The I/Q quadrature error is removed before the ModAcc 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_enabled(selector_string, value)[source]

Sets whether to enable the ModAcc 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 ModAcc 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 measurement length for the ModAcc measurement. This value is expressed in traffic 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.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the measurement length for the ModAcc measurement. This value is expressed in traffic 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 that is skipped by the ModAcc measurement from the synchronization boundary. This value is expressed in traffic slots. The synchronization boundary is specified by the MODACC_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 that is skipped by the ModAcc measurement from the synchronization boundary. This value is expressed in traffic slots. The synchronization boundary is specified by the MODACC_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_rrc_filter_enabled(selector_string, value)[source]

Sets whether to enable the RRC filter in the ModAcc measurement. Use this attribute to disable the filter if the received signal is already RRC-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 the RRC filter in the ModAcc measurement.

True (1)

Enables the RRC filter in the ModAcc measurement.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccRrcFilterEnabled, int) – Specifies whether to enable the RRC filter in the ModAcc measurement. Use this attribute to disable the filter if the received signal is already RRC-filtered.

Returns:

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

Return type:

int

set_slot_type(selector_string, value)[source]

Sets the type of the time slot for the ModAcc 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 Traffic.

Name (Value)

Description

Traffic (0)

The measurement is performed on the traffic time slot. The composite, data, and midamble ModAcc results are obtained when you select this slot type.

Pilot (1)

The measurement is performed on the pilot time slot. The pilot ModAcc results are obtained when you select this slot type.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccSlotType, int) – Specifies the type of the time slot for the ModAcc measurement.

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 not inverted.

True (1)

The measured spectrum is inverted.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccSpectrumInverted, 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 ModAcc 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 Slot.

Name (Value)

Description

Slot (0)

The measurement uses the slot synchronization mode. The slot boundary in the acquired signal is detected, and the measurement is performed over the number of slots specified by the ModAcc Meas Length attribute, starting at the offset from the boundary specified by the ModAcc Meas Offset attribute.

If you set the Trigger Type attribute to Digital Edge, you should provide the trigger at the start of the slot from which the ModAcc Meas Offset attribute should be considered. If you set the Trigger Type attribute to IQ Power Edge, it is required that the received signal has either one traffic time slot or contiguous traffic time slots. Additionally, for this trigger type, the traffic time slot(s) in the received signal should be contiguous with the pilot time slot, if the pilot time slot is present.

Subframe (1)

The measurement uses the subframe synchronization mode. The first subframe boundary in the acquired signal is detected, and the measurement is performed over the number of slots specified by the ModAcc Meas Length attribute, starting at the offset from the boundary specified by the ModAcc Meas Offset attribute.

If you set the Trigger Type attribute to Digital Edge, you should provide the trigger at the start of the subframe. If you set the Trigger Type attribute to IQ Power Edge, it is required that the received signal has either one traffic time slot or contiguous traffic time slots. Additionally, the traffic time slot should be contiguous with the active pilot time slot.
Parameters:
Returns:

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

Return type:

int