ModAccConfiguration

Provides methods to configure the ModAcc measurement.

class nirfmxcdma2k.modacc_configuration.ModAccConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the ModAcc measurement.

configure_synchronization_mode_and_interval(selector_string, synchronization_mode, measurement_offset, measurement_length)[source]

Configures the synchronization mode, offset, and length for modulation accuracy (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 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 expressed by the Measurement Length parameter, starting at Measurement Offset slots from the frame boundary.
Slot (1)	The slot boundary is detected and the measurement is performed over the number of slots expressed by the Measurement Length parameter, starting at Measurement Offset slots from the slot boundary.
Arbitrary (2)	The symbol boundary is detected and the measurement is performed over the number of slots expressed by the Measurement Length parameter, starting at Measurement Offset slots from the symbol boundary.

measurement_offset (int) – This parameter specifies the measurement offset to skip from the synchronization boundary. This value is expressed in slots.
measurement_length (int) – This parameter specifies the duration of the modulation accuracy 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

get_all_traces_enabled(selector_string)[source]

Gets whether to enable the traces to be stored and retrieved after performing the modulation accuracy (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 modulation accuracy (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 an EVM 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 EVM measurement.
True (1)	I/Q gain imbalance is removed before the EVM measurement.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccIQGainImbalanceRemovalEnabled):: Specifies whether to remove the I/Q gain imbalance before an EVM 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 an EVM 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 EVM measurement.
True (1)	I/Q offset is removed before the EVM measurement.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccIQOffsetRemovalEnabled):: Specifies whether to remove the I/Q offset before an EVM 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 an EVM 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 EVM measurement.
True (1)	I/Q quadrature error is removed before the EVM measurement.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccIQQuadratureErrorRemovalEnabled):: Specifies whether to remove the I/Q quadrature error before an EVM 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 modulation accuracy (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 modulation accuracy (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 duration of the modulation accuracy (ModAcc) 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 ModAcc measurement offset and the ModAcc 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 the modulation accuracy (ModAcc) 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 MODACC_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 16, inclusive. The sum of the ModAcc measurement offset and the ModAcc 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 MODACC_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_multi_carrier_filter_enabled(selector_string)[source]

Gets whether to enable the multi carrier filter which can be used to improve ModAcc measurement quality in presence of neighboring carriers.

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)	Disables multi carrier filter for ModAcc measurement.
True (1)	Enables multi carrier filter for ModAcc measurement.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccMultiCarrierFilterEnabled):: Specifies whether to enable the multi carrier filter which can be used to improve ModAcc measurement quality in presence of neighboring carriers.
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 ModAcc measurement. For RC1/2, this attribute refers to the band-limiting filter specified in the Chapter 6.4.2.1 of 3GPP2 C.S0011-E. For RC3/4, this attribute refers to the complementary filter specified in the Chapter 6.4.2.2 of 3GPP2 C.S0011-E.

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 received filtering for the ModAcc measurement.
True (1)	Enables received filtering for the ModAcc measurement.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccReceiveFilterEnabled):: Specifies whether to enable the received filter for the ModAcc measurement. For RC1/2, this attribute refers to the band-limiting filter specified in the Chapter 6.4.2.1 of 3GPP2 C.S0011-E. For RC3/4, this attribute refers to the complementary filter specified in the Chapter 6.4.2.2 of 3GPP2 C.S0011-E.
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 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 ModAcc Meas Length attribute starting at the ModAcc Meas Offset attribute from the frame boundary.
Slot (1)	The slot boundary is detected, and the measurement is performed over the ModAcc Meas Length attribute starting at the ModAcc Meas Offset attribute from the slot boundary.
Arbitrary (2)	The symbol boundary is detected, and the measurement is performed over the ModAcc Meas Length attribute starting at the ModAcc Meas Offset attribute from the slot boundary.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccSynchronizationMode):: 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 modulation accuracy (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 modulation accuracy (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 an EVM 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 EVM measurement.
True (1)	I/Q gain imbalance is removed before the EVM measurement.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.ModAccIQGainImbalanceRemovalEnabled, int) – Specifies whether to remove the I/Q gain imbalance before an EVM 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 an EVM 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 EVM measurement.
True (1)	I/Q offset is removed before the EVM measurement.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.ModAccIQOffsetRemovalEnabled, int) – Specifies whether to remove the I/Q offset before an EVM 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 an EVM 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 EVM measurement.
True (1)	I/Q quadrature error is removed before the EVM measurement.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.ModAccIQQuadratureErrorRemovalEnabled, int) – Specifies whether to remove the I/Q quadrature error before an EVM 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 modulation accuracy (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 modulation accuracy (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 duration of the modulation accuracy (ModAcc) 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 ModAcc measurement offset and the ModAcc measurement length must be less than or equal to 16.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the duration of the modulation accuracy (ModAcc) 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 MODACC_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 16, inclusive. The sum of the ModAcc measurement offset and the ModAcc 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 MODACC_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_multi_carrier_filter_enabled(selector_string, value)[source]

Sets whether to enable the multi carrier filter which can be used to improve ModAcc measurement quality in presence of neighboring carriers.

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)	Disables multi carrier filter for ModAcc measurement.
True (1)	Enables multi carrier filter for ModAcc measurement.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.ModAccMultiCarrierFilterEnabled, int) – Specifies whether to enable the multi carrier filter which can be used to improve ModAcc measurement quality in presence of neighboring carriers.

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 ModAcc measurement. For RC1/2, this attribute refers to the band-limiting filter specified in the Chapter 6.4.2.1 of 3GPP2 C.S0011-E. For RC3/4, this attribute refers to the complementary filter specified in the Chapter 6.4.2.2 of 3GPP2 C.S0011-E.

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 received filtering for the ModAcc measurement.
True (1)	Enables received filtering for the ModAcc measurement.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.ModAccReceiveFilterEnabled, int) – Specifies whether to enable the received filter for the ModAcc measurement. For RC1/2, this attribute refers to the band-limiting filter specified in the Chapter 6.4.2.1 of 3GPP2 C.S0011-E. For RC3/4, this attribute refers to the complementary filter specified in the Chapter 6.4.2.2 of 3GPP2 C.S0011-E.

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 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 ModAcc Meas Length attribute starting at the ModAcc Meas Offset attribute from the frame boundary.
Slot (1)	The slot boundary is detected, and the measurement is performed over the ModAcc Meas Length attribute starting at the ModAcc Meas Offset attribute from the slot boundary.
Arbitrary (2)	The symbol boundary is detected, and the measurement is performed over the ModAcc Meas Length attribute starting at the ModAcc Meas Offset attribute from the slot boundary.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.ModAccSynchronizationMode, 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