ModAccConfiguration

Provides methods to configure the ModAcc measurement.

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

Bases: object

Provides methods to configure the ModAcc measurement.

configure_reference_waveform(selector_string, x0, dx, reference_waveform)[source]

Configures the reference waveform such that it corresponds to the transmitted signal for the ModAcc measurement. This reference waveform helps achieve faster ModAcc measurements. This method is used only when you set the MODACC_SYNCHRONIZATION_MODE attribute to Marker.

Parameters:

selector_string (string) – Pass an empty string. The signal name that is passed when creating the signal configuration is used.
x0 (float) – This parameter specifies the start time. This value is expressed in seconds.
dx (float) – This parameter specifies the sample duration. This value is expressed in seconds.
reference_waveform (numpy.complex64) – This parameter specifies an array of the normalized ideal complex baseband samples, corresponding to the acquired signal. This value is expressed in volts.

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 of the ModAcc 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.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.
Marker (3)	The measurement is performed over the number of slots expressed by the Measurement Length parameter starting at Measurement Offset slots from the Trigger. This is the fastest way to do a ModAcc measurement. This mode requires the Trigger Type attribute to be set to Digital and the trigger must occur at the start of the frame. For more information about Marker mode, refer to Marker Mode.

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.

Valid values are [0, (15 - ModAcc Measurement Length)]. The sum of the ModAcc measurement offset and ModAcc measurement length must be less than or equal to 15.
measurement_length (int) –
This parameter specifies the duration for the modulation accuracy measurement. This value is expressed in slots. The default value is 1.

Valid values are [1,(15 - ModAcc Measurement Offset)]. The sum of the ModAcc measurement offset and ModAcc measurement length must be less than or equal to 15.

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

The channel code.

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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: The channel code.
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_downlink_timing_channel_spreading_factor(selector_string)[source]

The spreading factor.

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.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: The spreading factor.
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 I/Q gain imbalance before the ModAcc Measurement. In case of multi-carrier measurements, this attribute is valid only when you set the TRANSMITTER_ARCHITECTURE attribute is set to LO per Carrier.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the TRANSMITTER_ARCHITECTURE 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 I/Q gain imbalance before the ModAcc Measurement. In case of multi-carrier measurements, this attribute is valid only when you set the TRANSMITTER_ARCHITECTURE attribute is set to LO per Carrier.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_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. In case of multi-carrier measurements, this attribute is valid only when you set the TRANSMITTER_ARCHITECTURE attribute is set to LO per Carrier.

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. In case of multi-carrier measurements, this attribute is valid only when you set the TRANSMITTER_ARCHITECTURE attribute is set to LO per Carrier.
error_code (int):: Returns the status code of this method. The status code either indicates success or describes a warning condition.

Return type:

Tuple (attr_val, error_code)

get_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 duration of the 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. Valid values are [1, (15 - MODACC_MEASUREMENT_OFFSET)]. The sum of the ModAcc measurement offset and ModAcc measurement length must be less than or equal to 15.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):: Specifies the duration of 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_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 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. Valid values are [0, (15 - MODACC_MEASUREMENT_LENGTH )]. The sum of the ModAcc measurement offset and ModAcc measurement length must be less than or equal to 15.

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 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. 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 measurement.
True (1)	Enables the RRC filter in the measurement.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccRrcFilterEnabled):: Specifies whether to enable the RRC filter. 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_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.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 number of slots expressed by the ModAcc Measurement Length attribute starting at ModAcc 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 ModAcc Measurement Length attribute starting at ModAcc 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 ModAcc Measurement Length attribute starting at ModAcc Measurement Offset slots from the symbol boundary.
Marker (3)	The measurement is performed over the number of slots expressed by the ModAcc Measurement Length attribute starting at ModAcc Measurement Offset slots from the trigger. This is the fastest way to do a ModAcc measurement. This mode requires the Trigger Type attribute to be set to Digital and the trigger must occur at the start of the frame. For more information about Marker mode, refer to Marker Mode.

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)

get_transient_removal_enabled(selector_string)[source]

Gets whether the measurement excludes 25 microseconds from the start and end of each slot while computing the RMS EVM, peak EVM, RMS magnitude error and RMS phase error results.

Transients are expected to be present at the slot boundaries, where the mean power of the received signal can change.

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 entire measurement interval is used to compute the RMS EVM, peak EVM, RMS magnitude error, and RMS phase error results.
True (1)	The measurement excludes 25 microseconds from the start and end of each slot while computing the RMS EVM, peak EVM, RMS magnitude error, and RMS phase error results. The ModAcc Sync Mode attribute must be set to Frame, Slot, or Marker.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccTransientRemovalEnabled):: Specifies whether the measurement excludes 25 microseconds from the start and end of each slot while computing the RMS EVM, peak EVM, RMS magnitude error and RMS phase error 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)

set_all_traces_enabled(selector_string, value)[source]

Sets whether to enable the traces 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 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_downlink_timing_channel_code(selector_string, value)[source]

The channel code.

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.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – The channel code.

Returns:

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

Return type:

int

set_downlink_timing_channel_spreading_factor(selector_string, value)[source]

The spreading factor.

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.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – The spreading factor.

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 I/Q gain imbalance before the ModAcc Measurement. In case of multi-carrier measurements, this attribute is valid only when you set the TRANSMITTER_ARCHITECTURE attribute is set to LO per Carrier.

You do not need to use a selector string to configure or read this attribute for the default signal instance. Refer to the TRANSMITTER_ARCHITECTURE 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.
value (enums.ModAccIQGainImbalanceRemovalEnabled, int) – Specifies whether to remove I/Q gain imbalance before the ModAcc Measurement. In case of multi-carrier measurements, this attribute is valid only when you set the TRANSMITTER_ARCHITECTURE attribute is set to LO per Carrier.

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:

selector_string (string) – Pass an empty string.
value (enums.ModAccIQOffsetRemovalEnabled, int) – Specifies whether to remove the I/Q offset before 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_quadrature_error_removal_enabled(selector_string, value)[source]

Sets whether to remove the I/Q quadrature error before the ModAcc measurement. In case of multi-carrier measurements, this attribute is valid only when you set the TRANSMITTER_ARCHITECTURE attribute is set to LO per Carrier.

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.
value (enums.ModAccIQQuadratureErrorRemovalEnabled, int) – Specifies whether to remove the I/Q quadrature error before the ModAcc measurement. In case of multi-carrier measurements, this attribute is valid only when you set the TRANSMITTER_ARCHITECTURE attribute is set to LO per Carrier.

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 duration of the 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. Valid values are [1, (15 - MODACC_MEASUREMENT_OFFSET)]. The sum of the ModAcc measurement offset and ModAcc measurement length must be less than or equal to 15.

Parameters:

selector_string (string) – Pass an empty string.
value (int) – Specifies the duration of 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_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 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. Valid values are [0, (15 - MODACC_MEASUREMENT_LENGTH )]. The sum of the ModAcc measurement offset and ModAcc measurement length must be less than or equal to 15.

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 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. 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 measurement.
True (1)	Enables the RRC filter in the measurement.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.ModAccRrcFilterEnabled, int) – Specifies whether to enable the RRC filter. 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_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.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 number of slots expressed by the ModAcc Measurement Length attribute starting at ModAcc 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 ModAcc Measurement Length attribute starting at ModAcc 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 ModAcc Measurement Length attribute starting at ModAcc Measurement Offset slots from the symbol boundary.
Marker (3)	The measurement is performed over the number of slots expressed by the ModAcc Measurement Length attribute starting at ModAcc Measurement Offset slots from the trigger. This is the fastest way to do a ModAcc measurement. This mode requires the Trigger Type attribute to be set to Digital and the trigger must occur at the start of the frame. For more information about Marker mode, refer to Marker Mode.

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

set_transient_removal_enabled(selector_string, value)[source]

Sets whether the measurement excludes 25 microseconds from the start and end of each slot while computing the RMS EVM, peak EVM, RMS magnitude error and RMS phase error results.

Transients are expected to be present at the slot boundaries, where the mean power of the received signal can change.

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 entire measurement interval is used to compute the RMS EVM, peak EVM, RMS magnitude error, and RMS phase error results.
True (1)	The measurement excludes 25 microseconds from the start and end of each slot while computing the RMS EVM, peak EVM, RMS magnitude error, and RMS phase error results. The ModAcc Sync Mode attribute must be set to Frame, Slot, or Marker.

Parameters:

selector_string (string) – Pass an empty string.
value (enums.ModAccTransientRemovalEnabled, int) – Specifies whether the measurement excludes 25 microseconds from the start and end of each slot while computing the RMS EVM, peak EVM, RMS magnitude error and RMS phase error results.

Returns:

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

Return type:

int