ModAccConfiguration

Provides methods to configure the ModAcc measurement.

class nirfmxlte.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 measurement. The default value is False.

    Name (Value)

    Description

    False (0)

    The measurement is performed on a single acquisition.

    True (1)

    The measurement is averaged over multiple acquisitions. The number of acquisitions is obtained by the Averaging Count parameter.

  • 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_common_clock_source_enabled(selector_string, common_clock_source_enabled)[source]

Configures the Reference Clock and specifies whether same Reference Clock is used for local oscillator and D/A converter.

The modacc measurement ignores this method, when you set the LINK_DIRECTION attribute to Downlink.

Parameters:

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

  • common_clock_source_enabled (enums.ModAccCommonClockSourceEnabled, int) –

    This parameter specifies whether the same Reference Clock is used for the local oscillator and the D/A converter. When the same Reference Clock is used, the carrier frequency offset is proportional to the Sample Clock error. The default value is True.

    Name (Value)

    Description

    False (0)

    The Sample Clock error is estimated independently.

    True (1)

    The Sample Clock error is estimated from carrier frequency offset.

Returns:

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

Return type:

int

configure_evm_unit(selector_string, evm_unit)[source]

Configures the units of the EVM results.

Parameters:

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

  • evm_unit (enums.ModAccEvmUnit, int) –

    This parameter specifies the units of the EVM results. The default value is Percentage.

    Name (Value)

    Description

    Percentage (0)

    The EVM is reported in percentage.

    dB (1)

    The EVM is reported in dB.

Returns:

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

Return type:

int

configure_fft_window_offset(selector_string, fft_window_offset)[source]

Configures the position of the FFT window that is used to calculate the EVM.

Parameters:

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

  • fft_window_offset (float) – This parameter specifies the position of the FFT window that is used to calculate the EVM. The offset is expressed as a percentage of the cyclic prefix length. If you set this parameter to 0, the EVM window starts from the end of cyclic prefix. If you set this parameter to 100, the EVM window starts from the beginning of cyclic prefix. The default value is 50. Valid values are 0 to 100, inclusive.

Returns:

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

Return type:

int

configure_fft_window_position(selector_string, fft_window_type, fft_window_offset, fft_window_length)[source]

Configures the FFT window position used for an EVM calculation.

Refer to the LTE Modulation Accuracy topic for more information about FFT window position.

Parameters:

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

  • fft_window_type (enums.ModAccFftWindowType, int) –

    This parameter specifies the FFT window type used for an EVM calculation. The default value is Custom.

    Name (Value)

    Description

    3GPP (0)

    The maximum EVM between the start window position and the end window position is returned according to the 3GPP specification. The window positions are specified by the ModAcc FFT Window Length parameter. For more information about the FFT window specification, refer to the 3GPP TS 36.521 specification, Annexe E.3.2.

    Custom (1)

    Only one FFT window position is used for the EVM calculation. The FFT window position is specified by the ModAcc FFT Window Offset parameter.

  • fft_window_offset (float) –

    This parameter specifies the position of the FFT window used to calculate the EVM. The offset is expressed as a percentage of the cyclic prefix length. If you set this parameter to 0, the EVM window starts from the end of cyclic prefix. If you set this parameter to 100, the EVM window starts from the beginning of cyclic prefix.

    The default value is 50. Valid values are 0 to 100, inclusive.

  • fft_window_length (float) –

    This parameter specifies the FFT window length. This value is expressed in a percentage of the cyclic prefix length. This parameter is used when you set the ModAcc FFT Window Type parameter to 3GPP, where you need to calculate the EVM using two different FFT window positions, Delta_C-W/2, and Delta_C+W/2.

    The default value is -1. Valid values are -1 to 100, inclusive. When this attribute is set to -1, the RFmx populates the FFT Window Length based on carrier bandwidth automatically, as given in the*3GPP 36.104* specification, Annexe E.5.1.

Returns:

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

Return type:

int

configure_in_band_emission_mask_type(selector_string, in_band_emission_mask_type)[source]

Configures the In-Band Emission Mask Type parameter to be used.

Parameters:

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

  • in_band_emission_mask_type (enums.ModAccInBandEmissionMaskType, int) –

    This parameter specifies the in-band emissions mask type to be used for measuring in-band emission margin (dB) and subblock in-Band emission margin (dB) results.

    Refer to section 6.5.2.3.5 of the 3GPP 36.521-1 specification for more information.

    The default value is Release 8-10 for bandwidths other than 200 KHz and LINK_DIRECTION is False. It is Release 11 Onwards, otherwise.

    Name (Value)

    Description

    Release 8-10 (0)

    Specifies the mask type to be used for UE, supporting 3GPP Release 8 to 3GPP Release 10 specification.

    Release 11 Onwards (1)

    Specifies the mask type to be used for UE, supporting 3GPP Release 11 and higher specification.

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, the Measurement Offset, and the Measurement Length parameters of the ModAcc measurement.

Refer to the LTE Modulation Accuracy topic for more information about ModAcc measurements.

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 or the slot boundary. The default value is Slot.

    When you set the LINK_DIRECTION attribute to Downlink, the measurement supports only Frame synchronization mode.

    Name (Value)

    Description

    Frame (0)

    The frame boundary is detected, and the measurement is performed over the Measurement Length parameter, starting at the Measurement Offset parameter from the frame boundary. When you set the Trigger Type attribute to Digital Edge, the measurement expects a trigger at the frame boundary.

    Slot (1)

    The slot boundary is detected, and the measurement is performed over the Measurement Length parameter starting at the Measurement Offset parameter from the slot boundary. When you set the Trigger Type attribute to Digital Edge, the measurement expects a trigger at any slot boundary.

    Marker (2)

    The measurement expects a marker (trigger) at the frame boundary from the user. The measurement takes advantage of triggered acquisitions to reduce processing resulting in faster measurement time. Measurement is performed over the Measurement Length parameter starting at the Measurement Offset parameter from the frame boundary.

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

  • measurement_length (int) – This parameter specifies the number of slots to be measured. 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 measurement is averaged over multiple acquisitions. The number of acquisitions is obtained by the ModAcc Averaging Count attribute.
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_channel_estimation_type(selector_string)[source]

Gets the method used for the channel estimation for the ModAcc measurement. The measurement ignores this attribute, when you set the LINK_DIRECTION attribute to Downlink.

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 Reference+Data.

Name (Value)

Description

Reference (0)

Only the demodulation reference signal (DMRS) symbol is used to calculate the channel coefficients.

Reference+Data (1)

Both the DMRS symbol and the data symbol are used to calculate the channel coefficients, as specified by the 3GPP 36.521 specification, Annexe E.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccChannelEstimationType):

Specifies the method used for the channel estimation for the ModAcc measurement. The measurement ignores this attribute, when you set the LINK_DIRECTION attribute to Downlink.

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

Gets whether the same Reference Clock is used for the local oscillator and the digital-to-analog converter in the transmitter. When the same Reference Clock is used, the carrier frequency offset is proportional to Sample Clock error.

The ModAcc measurement ignores this attribute, when you set the LINK_DIRECTION attribute to Downlink.

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)

The Sample Clock error is estimated independently.

True (1)

The Sample Clock error is estimated from carrier frequency offset.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccCommonClockSourceEnabled):

Specifies whether the same Reference Clock is used for the local oscillator and the digital-to-analog converter in the transmitter. When the same Reference Clock is used, the carrier frequency offset is proportional to Sample Clock error.

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

Gets the units of the EVM 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 Percentage.

Name (Value)

Description

Percentage (0)

The EVM is reported as a percentage.

dB (1)

The EVM is reported in dB.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccEvmUnit):

Specifies the units of the EVM 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_evm_with_exclusion_period_enabled(selector_string)[source]

Gets whether to exclude some portion of the slots when calculating the EVM. This attribute is valid only when there is a power change at the slot boundary. Refer to section 6.5.2.1A of the 3GPP TS 36.521-1 specification for more information about exclusion.

The measurement ignores this attribute, when you set the LINK_DIRECTION attribute to Downlink.

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)

EVM is calculated on complete slots.

True (1)

EVM is calculated on truncated slots. The power changes at the slot boundaries are detected by the measurement, and the defined 3GPP specification period is excluded from the slots being measured.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccEvmWithExclusionPeriodEnabled):

Specifies whether to exclude some portion of the slots when calculating the EVM. This attribute is valid only when there is a power change at the slot boundary. Refer to section 6.5.2.1A of the 3GPP TS 36.521-1 specification for more information about exclusion.

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

Gets the FFT window length (W). This value is expressed as a percentage of the cyclic prefix length. This attribute is used when you set the MODACC_FFT_WINDOW_TYPE attribute to 3GPP, where it is needed to calculate the EVM using two different FFT window positions, Delta_C-W/2, and Delta_C+W/2. Refer to the Annexe E.3.2 of 3GPP 36.521 specification for more information.

Refer to the LTE Modulation Accuracy topic for more information about FFT Window Length.

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 as given in the 3GPP specification. The default value is 91.7 %CP for 10M bandwidth. Valid values range from -1 to 100, inclusive.

When this attribute is set to -1, RFmx populates the FFT Window Length based on carrier bandwidth automatically, as given in the Annexe E.5.1 of 3GPP 36.104 specification.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the FFT window length (W). This value is expressed as a percentage of the cyclic prefix length. This attribute is used when you set the MODACC_FFT_WINDOW_TYPE attribute to 3GPP, where it is needed to calculate the EVM using two different FFT window positions, Delta_C-W/2, and Delta_C+W/2. Refer to the Annexe E.3.2 of 3GPP 36.521 specification for more information.

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

Gets the position of the FFT window used to calculate the EVM. The offset is expressed as a percentage of the cyclic prefix length. If you set this attribute to 0, the EVM window starts at the end of cyclic prefix. If you set this attribute to 100, the EVM window starts at the beginning of cyclic prefix.

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 50. Valid values are 0 to 100, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the position of the FFT window used to calculate the EVM. The offset is expressed as a percentage of the cyclic prefix length. If you set this attribute to 0, the EVM window starts at the end of cyclic prefix. If you set this attribute to 100, the EVM window starts at the beginning of cyclic prefix.

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

Gets the FFT window type used for the EVM calculation for the ModAcc measurement.

Refer to the LTE Modulation Accuracy topic for more information about FFT window type.

The default value is Custom.

Name (Value)

Description

3GPP (0)

The maximum EVM between the start window position and the end window position is returned according to the 3GPP specification. The FFT window positions are specified by the attribute. Refer to the Annexe E.3.2 of 3GPP TS 36.521 specification for more information on the FFT window.

Custom (1)

Only one FFT window position is used for the EVM calculation. FFT window position is specified by ModAcc FFT Window Offset attribute.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccFftWindowType):

Specifies the FFT window type used for the EVM calculation 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_frequency_error_estimation(selector_string)[source]

Gets the operation mode of frequency error estimation.

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

Name (Value)

Description

Normal (1)

Estimate and correct frequency error of range +/- half subcarrier spacing.

Wide (2)

Estimate and correct frequency error of range +/- half resource block when Auto RB Detection Enabled is True, or range +/- number of guard subcarrier when Auto RB Detection Enabled is False.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccFrequencyErrorEstimation):

Specifies the operation mode of frequency error estimation.

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

Gets the in-band emissions mask type to be used for measuring in-band emission margin (dB) and subblock in-Band emission margin (dB) results.

Refer to section 6.5.2.3.5 of the 3GPP 36.521-1 specification for more information.

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 Release 8-10 for bandwidths other than 200 KHz and EMTC_ANALYSIS_ENABLED is False. It is Release 11 Onwards, otherwise.

Name (Value)

Description

Release 8-10 (0)

Specifies the mask type to be used for UE, supporting 3GPP Release 8 to 3GPP Release 10 specification.

Release 11 Onwards (1)

Specifies the mask type to be used for UE, supporting 3GPP Release 11 and higher specification.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccInBandEmissionMaskType):

Specifies the in-band emissions mask type to be used for measuring in-band emission margin (dB) and subblock in-Band emission margin (dB) 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_iq_gain_imbalance_correction_enabled(selector_string)[source]

Gets whether to enable IQ gain imbalance correction.

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)

IQ gain imbalance correction is disabled.

True (1)

IQ gain imbalance correction is enabled.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccIQGainImbalanceCorrectionEnabled):

Specifies whether to enable IQ gain imbalance correction.

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

Gets whether to estimate IQ mismatch such as gain imbalance, quadrature skew, and timing skew.

Note

Timing skew value is estimated only when you set the LINK_DIRECTION attribute to Uplink.

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)

IQ mismatch estimation is disabled.

True (1)

IQ mismatch estimation is enabled.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccIQMismatchEstimationsEnabled):

Specifies whether to estimate IQ mismatch such as gain imbalance, quadrature skew, and timing skew.

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

Gets whether to estimate IQ origin offset.

Note

IQ origin offset estimation is supported only when you set the LINK_DIRECTION attribute to Uplink or Sidelink .

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)

IQ origin offset estimation and correction is disabled.

True (1)

IQ origin offset estimation and correction is enabled.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccIQOriginOffsetEstimationEnabled):

Specifies whether to estimate IQ origin offset.

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

Gets whether to enable IQ quadrature error correction.

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)

IQ quadrature error correction is disabled.

True (1)

IQ quadrature error correction is enabled.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccIQQuadratureErrorCorrectionEnabled):

Specifies whether to enable IQ quadrature error correction.

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

Gets whether to enable IQ timing skew correction.

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)

IQ timing skew correction is disabled.

True (1)

IQ timing skew correction is enabled.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccIQTimingSkewCorrectionEnabled):

Specifies whether to enable IQ timing skew correction.

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 number of slots to be measured. This value is expressed in slots. For NB-IoT a measurement length of 20 slots is recommended.

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 number of slots to be measured. This value is expressed in slots. For NB-IoT a measurement length of 20 slots is recommended.

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. For uplink, the upper limit is 19. For downlink, the upper limit is (2*:py:attr:~nirfmxlte.attributes.AttributeID.DOWNLINK_NUMBER_OF_SUBFRAMES - 1).

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

Gets whether to use a filter to suppress the interference from out of band emissions into the carriers being measured.

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 does not use the multicarrier filter.

True (1)

The measurement filters out interference from out of band emissions into the carriers being measured.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccMulticarrierFilterEnabled):

Specifies whether to use a filter to suppress the interference from out of band emissions into the carriers being measured.

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

Gets the time synchronization mode used in uplink in the case of carrier aggregation.

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

Name (Value)

Description

Common (0)

Specifies that a common time synchronization value is used for synchronization of all the component carriers and time synchronization value is obtained from the synchronization of the first active component carrier of the first subblock.

Per Carrier (1)

Specifies that time synchronization is performed on each component carrier.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccMulticarrierTimeSynchronizationMode):

Specifies the time synchronization mode used in uplink in the case of carrier aggregation.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_number_of_analysis_threads(selector_string)[source]

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

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

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

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

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

Gets whether phase tracking is enabled.

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 the Phase Tracking.

True (1)

All the reference and data symbols are used for Phase Tracking.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccPhaseTrackingEnabled):

Specifies whether phase tracking is enabled.

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

Gets the interval used for Pre-FFT Error Estimation.

Pre-FFT Error Estimation Interval set to Slot is valid only when the LINK_DIRECTION attribute is set to Uplink. Pre-FFT Error Estimation Interval set to Subframe is valid only when the LINK_DIRECTION attribute is set to Downlink.

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 Measurement Length.

Name (Value)

Description

Slot (0)

Frequency and Timing Error is estimated per slot in the pre-fft domain.

Subframe (1)

Frequency and Timing Error is estimated per subframe in the pre-fft domain.

Measurement Length (2)

Frequency and Timing Error is estimated over the measurement interval in the pre-fft domain.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccPreFftErrorEstimationInterval):

Specifies the interval used for Pre-FFT Error Estimation.

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

Gets the frequency ranges at which to measure spectral flatness. The measurement ignores this attribute, when you set the LINK_DIRECTION attribute to Downlink.

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

Name (Value)

Description

Normal (0)

Uses the frequency range defined in the section 6.5.2.4.5, and table 6.5.2.4.3-1 of 3GPP 36.521 specification.

Extreme (1)

Uses the frequency range defined in the section 6.5.2.4.5, and table 6.5.2.4.3-2 of 3GPP 36.521 specification.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccSpectralFlatnessCondition):

Specifies the frequency ranges at which to measure spectral flatness. The measurement ignores this attribute, when you set the LINK_DIRECTION attribute to Downlink.

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 measured signal is inverted. The inversion happens when the I and the Q components of the baseband complex signal are swapped.

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 of the measured signal is not inverted.

True (1)

The measured signal is inverted and the measurement corrects the signal by swapping the I and the Q components.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccSpectrumInverted):

Specifies whether the spectrum of the measured signal is inverted. The inversion happens when the I and the Q components of the baseband complex signal are swapped.

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

Gets whether to estimate symbol clock error.

If symbol clock error is not present in the signal to be analyzed, symbol clock error estimation may be disabled to reduce measurement time or to avoid measurement inaccuracy due to error in symbol clock error estimation.

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)

Symbol Clock Error estimation and correction is disabled.

True (1)

Symbol Clock Error estimation and correction is enabled.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccSymbolClockErrorEstimationEnabled):

Specifies whether to estimate symbol clock error.

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 or the slot 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.

Refer to the LTE Modulation Accuracy topic for more information about synchronization mode.

The default value is Slot.

Note

When you set the LINK_DIRECTION attribute to Downlink, the measurement supports only Frame synchronization mode.

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. When you set the Trigger Type attribute to Digital Edge, the measurement expects a trigger at 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. When you set the Trigger Type attribute to Digital Edge, the measurement expects a trigger at any slot boundary.

Marker (2)

The measurement expects a marker (trigger) at the frame boundary from the user. The measurement takes advantage of triggered acquisitions to reduce processing resulting in faster measurement time. Measurement is performed over the ModAcc Meas Length attribute starting at ModAcc Meas Offset attribute from the frame boundary.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccSynchronizationMode):

Specifies whether the measurement is performed from the frame or the slot 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_timing_tracking_enabled(selector_string)[source]

Gets whether timing tracking is enabled.

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 the Timing Tracking.

True (1)

All the reference and data symbols are used for Timing Tracking.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccTimingTrackingEnabled):

Specifies whether timing tracking is enabled.

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 measurement is averaged over multiple acquisitions. The number of acquisitions is obtained by the ModAcc Averaging Count attribute.
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_channel_estimation_type(selector_string, value)[source]

Sets the method used for the channel estimation for the ModAcc measurement. The measurement ignores this attribute, when you set the LINK_DIRECTION attribute to Downlink.

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 Reference+Data.

Name (Value)

Description

Reference (0)

Only the demodulation reference signal (DMRS) symbol is used to calculate the channel coefficients.

Reference+Data (1)

Both the DMRS symbol and the data symbol are used to calculate the channel coefficients, as specified by the 3GPP 36.521 specification, Annexe E.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccChannelEstimationType, int) – Specifies the method used for the channel estimation for the ModAcc measurement. The measurement ignores this attribute, when you set the LINK_DIRECTION attribute to Downlink.

Returns:

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

Return type:

int

set_common_clock_source_enabled(selector_string, value)[source]

Sets whether the same Reference Clock is used for the local oscillator and the digital-to-analog converter in the transmitter. When the same Reference Clock is used, the carrier frequency offset is proportional to Sample Clock error.

The ModAcc measurement ignores this attribute, when you set the LINK_DIRECTION attribute to Downlink.

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)

The Sample Clock error is estimated independently.

True (1)

The Sample Clock error is estimated from carrier frequency offset.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccCommonClockSourceEnabled, int) – Specifies whether the same Reference Clock is used for the local oscillator and the digital-to-analog converter in the transmitter. When the same Reference Clock is used, the carrier frequency offset is proportional to Sample Clock error.

Returns:

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

Return type:

int

set_evm_unit(selector_string, value)[source]

Sets the units of the EVM 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 Percentage.

Name (Value)

Description

Percentage (0)

The EVM is reported as a percentage.

dB (1)

The EVM is reported in dB.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccEvmUnit, int) – Specifies the units of the EVM results.

Returns:

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

Return type:

int

set_evm_with_exclusion_period_enabled(selector_string, value)[source]

Sets whether to exclude some portion of the slots when calculating the EVM. This attribute is valid only when there is a power change at the slot boundary. Refer to section 6.5.2.1A of the 3GPP TS 36.521-1 specification for more information about exclusion.

The measurement ignores this attribute, when you set the LINK_DIRECTION attribute to Downlink.

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)

EVM is calculated on complete slots.

True (1)

EVM is calculated on truncated slots. The power changes at the slot boundaries are detected by the measurement, and the defined 3GPP specification period is excluded from the slots being measured.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccEvmWithExclusionPeriodEnabled, int) – Specifies whether to exclude some portion of the slots when calculating the EVM. This attribute is valid only when there is a power change at the slot boundary. Refer to section 6.5.2.1A of the 3GPP TS 36.521-1 specification for more information about exclusion.

Returns:

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

Return type:

int

set_fft_window_length(selector_string, value)[source]

Sets the FFT window length (W). This value is expressed as a percentage of the cyclic prefix length. This attribute is used when you set the MODACC_FFT_WINDOW_TYPE attribute to 3GPP, where it is needed to calculate the EVM using two different FFT window positions, Delta_C-W/2, and Delta_C+W/2. Refer to the Annexe E.3.2 of 3GPP 36.521 specification for more information.

Refer to the LTE Modulation Accuracy topic for more information about FFT Window Length.

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 as given in the 3GPP specification. The default value is 91.7 %CP for 10M bandwidth. Valid values range from -1 to 100, inclusive.

When this attribute is set to -1, RFmx populates the FFT Window Length based on carrier bandwidth automatically, as given in the Annexe E.5.1 of 3GPP 36.104 specification.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the FFT window length (W). This value is expressed as a percentage of the cyclic prefix length. This attribute is used when you set the MODACC_FFT_WINDOW_TYPE attribute to 3GPP, where it is needed to calculate the EVM using two different FFT window positions, Delta_C-W/2, and Delta_C+W/2. Refer to the Annexe E.3.2 of 3GPP 36.521 specification for more information.

Returns:

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

Return type:

int

set_fft_window_offset(selector_string, value)[source]

Sets the position of the FFT window used to calculate the EVM. The offset is expressed as a percentage of the cyclic prefix length. If you set this attribute to 0, the EVM window starts at the end of cyclic prefix. If you set this attribute to 100, the EVM window starts at the beginning of cyclic prefix.

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 50. Valid values are 0 to 100, inclusive.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the position of the FFT window used to calculate the EVM. The offset is expressed as a percentage of the cyclic prefix length. If you set this attribute to 0, the EVM window starts at the end of cyclic prefix. If you set this attribute to 100, the EVM window starts at the beginning of cyclic prefix.

Returns:

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

Return type:

int

set_fft_window_type(selector_string, value)[source]

Sets the FFT window type used for the EVM calculation for the ModAcc measurement.

Refer to the LTE Modulation Accuracy topic for more information about FFT window type.

The default value is Custom.

Name (Value)

Description

3GPP (0)

The maximum EVM between the start window position and the end window position is returned according to the 3GPP specification. The FFT window positions are specified by the attribute. Refer to the Annexe E.3.2 of 3GPP TS 36.521 specification for more information on the FFT window.

Custom (1)

Only one FFT window position is used for the EVM calculation. FFT window position is specified by ModAcc FFT Window Offset attribute.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccFftWindowType, int) – Specifies the FFT window type used for the EVM calculation 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_frequency_error_estimation(selector_string, value)[source]

Sets the operation mode of frequency error estimation.

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

Name (Value)

Description

Normal (1)

Estimate and correct frequency error of range +/- half subcarrier spacing.

Wide (2)

Estimate and correct frequency error of range +/- half resource block when Auto RB Detection Enabled is True, or range +/- number of guard subcarrier when Auto RB Detection Enabled is False.
Parameters:
Returns:

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

Return type:

int

set_in_band_emission_mask_type(selector_string, value)[source]

Sets the in-band emissions mask type to be used for measuring in-band emission margin (dB) and subblock in-Band emission margin (dB) results.

Refer to section 6.5.2.3.5 of the 3GPP 36.521-1 specification for more information.

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 Release 8-10 for bandwidths other than 200 KHz and EMTC_ANALYSIS_ENABLED is False. It is Release 11 Onwards, otherwise.

Name (Value)

Description

Release 8-10 (0)

Specifies the mask type to be used for UE, supporting 3GPP Release 8 to 3GPP Release 10 specification.

Release 11 Onwards (1)

Specifies the mask type to be used for UE, supporting 3GPP Release 11 and higher specification.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccInBandEmissionMaskType, int) – Specifies the in-band emissions mask type to be used for measuring in-band emission margin (dB) and subblock in-Band emission margin (dB) results.

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

Sets whether to enable IQ gain imbalance correction.

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)

IQ gain imbalance correction is disabled.

True (1)

IQ gain imbalance correction is enabled.
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_mismatch_estimation_enabled(selector_string, value)[source]

Sets whether to estimate IQ mismatch such as gain imbalance, quadrature skew, and timing skew.

Note

Timing skew value is estimated only when you set the LINK_DIRECTION attribute to Uplink.

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)

IQ mismatch estimation is disabled.

True (1)

IQ mismatch estimation is enabled.
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_origin_offset_estimation_enabled(selector_string, value)[source]

Sets whether to estimate IQ origin offset.

Note

IQ origin offset estimation is supported only when you set the LINK_DIRECTION attribute to Uplink or Sidelink .

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)

IQ origin offset estimation and correction is disabled.

True (1)

IQ origin offset estimation and correction is enabled.
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_correction_enabled(selector_string, value)[source]

Sets whether to enable IQ quadrature error correction.

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)

IQ quadrature error correction is disabled.

True (1)

IQ quadrature error correction is enabled.
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_timing_skew_correction_enabled(selector_string, value)[source]

Sets whether to enable IQ timing skew correction.

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)

IQ timing skew correction is disabled.

True (1)

IQ timing skew correction is enabled.
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 number of slots to be measured. This value is expressed in slots. For NB-IoT a measurement length of 20 slots is recommended.

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 number of slots to be measured. This value is expressed in slots. For NB-IoT a measurement length of 20 slots is recommended.

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. For uplink, the upper limit is 19. For downlink, the upper limit is (2*:py:attr:~nirfmxlte.attributes.AttributeID.DOWNLINK_NUMBER_OF_SUBFRAMES - 1).

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

Sets whether to use a filter to suppress the interference from out of band emissions into the carriers being measured.

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 does not use the multicarrier filter.

True (1)

The measurement filters out interference from out of band emissions into the carriers being measured.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccMulticarrierFilterEnabled, int) – Specifies whether to use a filter to suppress the interference from out of band emissions into the carriers being measured.

Returns:

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

Return type:

int

set_multicarrier_time_synchronization_mode(selector_string, value)[source]

Sets the time synchronization mode used in uplink in the case of carrier aggregation.

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

Name (Value)

Description

Common (0)

Specifies that a common time synchronization value is used for synchronization of all the component carriers and time synchronization value is obtained from the synchronization of the first active component carrier of the first subblock.

Per Carrier (1)

Specifies that time synchronization is performed on each component carrier.
Parameters:
Returns:

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

Return type:

int

set_number_of_analysis_threads(selector_string, value)[source]

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

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

The default value is 1.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the maximum number of threads used for parallelism for the ModAcc measurement. The number of threads can range from 1 to the number of physical cores. The number of threads you set may not be used in calculations. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations.

Returns:

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

Return type:

int

set_phase_tracking_enabled(selector_string, value)[source]

Sets whether phase tracking is enabled.

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 the Phase Tracking.

True (1)

All the reference and data symbols are used for Phase Tracking.
Parameters:
Returns:

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

Return type:

int

set_pre_fft_error_estimation_interval(selector_string, value)[source]

Sets the interval used for Pre-FFT Error Estimation.

Pre-FFT Error Estimation Interval set to Slot is valid only when the LINK_DIRECTION attribute is set to Uplink. Pre-FFT Error Estimation Interval set to Subframe is valid only when the LINK_DIRECTION attribute is set to Downlink.

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 Measurement Length.

Name (Value)

Description

Slot (0)

Frequency and Timing Error is estimated per slot in the pre-fft domain.

Subframe (1)

Frequency and Timing Error is estimated per subframe in the pre-fft domain.

Measurement Length (2)

Frequency and Timing Error is estimated over the measurement interval in the pre-fft domain.
Parameters:
Returns:

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

Return type:

int

set_spectral_flatness_condition(selector_string, value)[source]

Sets the frequency ranges at which to measure spectral flatness. The measurement ignores this attribute, when you set the LINK_DIRECTION attribute to Downlink.

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

Name (Value)

Description

Normal (0)

Uses the frequency range defined in the section 6.5.2.4.5, and table 6.5.2.4.3-1 of 3GPP 36.521 specification.

Extreme (1)

Uses the frequency range defined in the section 6.5.2.4.5, and table 6.5.2.4.3-2 of 3GPP 36.521 specification.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccSpectralFlatnessCondition, int) – Specifies the frequency ranges at which to measure spectral flatness. The measurement ignores this attribute, when you set the LINK_DIRECTION attribute to Downlink.

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 measured signal is inverted. The inversion happens when the I and the Q components of the baseband complex signal are swapped.

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 of the measured signal is not inverted.

True (1)

The measured signal is inverted and the measurement corrects the signal by swapping the I and the Q components.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccSpectrumInverted, int) – Specifies whether the spectrum of the measured signal is inverted. The inversion happens when the I and the Q components of the baseband complex signal are swapped.

Returns:

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

Return type:

int

set_symbol_clock_error_estimation_enabled(selector_string, value)[source]

Sets whether to estimate symbol clock error.

If symbol clock error is not present in the signal to be analyzed, symbol clock error estimation may be disabled to reduce measurement time or to avoid measurement inaccuracy due to error in symbol clock error estimation.

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)

Symbol Clock Error estimation and correction is disabled.

True (1)

Symbol Clock Error estimation and correction is enabled.
Parameters:
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 or the slot 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.

Refer to the LTE Modulation Accuracy topic for more information about synchronization mode.

The default value is Slot.

Note

When you set the LINK_DIRECTION attribute to Downlink, the measurement supports only Frame synchronization mode.

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. When you set the Trigger Type attribute to Digital Edge, the measurement expects a trigger at 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. When you set the Trigger Type attribute to Digital Edge, the measurement expects a trigger at any slot boundary.

Marker (2)

The measurement expects a marker (trigger) at the frame boundary from the user. The measurement takes advantage of triggered acquisitions to reduce processing resulting in faster measurement time. Measurement is performed over the ModAcc Meas Length attribute starting at ModAcc Meas Offset attribute from the frame boundary.
Parameters:

  • selector_string (string) – Pass an empty string.

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

Returns:

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

Return type:

int

set_timing_tracking_enabled(selector_string, value)[source]

Sets whether timing tracking is enabled.

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 the Timing Tracking.

True (1)

All the reference and data symbols are used for Timing Tracking.
Parameters:
Returns:

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

Return type:

int