ModAccConfiguration

Provides methods to configure the ModAcc measurement.

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

Bases: object

Provides methods to configure the ModAcc measurement.

auto_level(selector_string, timeout)[source]

Performs the user-configured ModAcc measurement at multiple reference levels relative to the user-configured REFERENCE_LEVEL attribute and configures the reference level corresponding to the lowest MODACC_RESULTS_COMPOSITE_RMS_EVM_MEAN result.

This method only measures at the reference levels that do not result in an ADC or DSP overflow when you set the MODACC_AUTO_LEVEL_ALLOW_OVERFLOW attribute to False. If you set the ModAcc Auto Level Allow Overflow attribute to True, this method measures at a few reference levels beyond the overflow. After calling the ModAcc Auto Level method, you need to call the ModAcc measurement.

Note

Calling this method will also set the REFERENCE_LEVEL_HEADROOM attribute to 0.

This method expects:

  • A valid ModAcc measurement configuration

  • Reference Level attribute set to peak power of the signal

  • Repetitive signals at the analyzer’s input along with trigger settings that measure the same portion of the waveform every time the measurement is performed

  • No other measurements are running in parallel

Auto level needs to be performed again if the input signal or RFmx configuration changes.

For repeatable results, you must make sure that the ModAcc measurement is repeatable.

This method measures EVM at reference levels starting at an integer at least 1 dB above the value you configure for the Reference Level attribute, extending upto 12 dB lower when you set the ModAcc Auto Level Allow Overflow attribute to False, and up to 17 dB lower when you set the ModAcc Auto Level Allow Overflow attribute to True with a step size of 0.5 dB.

When you use this method with the MODACC_NOISE_COMPENSATION_ENABLED attribute set to True, you need to make sure that valid noise calibration data is available for the above measurements.

Parameters:

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

  • timeout (float) – This parameter specifies the timeout for fetching the EVM results. This value is expressed in seconds. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete. 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

clear_noise_calibration_database()[source]

Clears the noise calibration database used for EVM noise compensation.

Returns:

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

Return type:

int

configure_measurement_mode(selector_string, measurement_mode)[source]

Configures the measurement mode 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.

  • measurement_mode (enums.ModAccMeasurementMode, int) –

    This parameter specifies whether the measurement should calibrate the noise floor of the analyzer or perform the ModAcc measurement. The default value is Measure.

    Name (Value)

    Description

    Measure (0)

    The ModAcc measurement is performed on the acquired signal.

    Calibrate Noise Floor (1)

    The ModAcc measurement measures the noise floor of the instrument across the frequency range of interest determined by the carrier frequency and channel bandwidth. In this mode, the measurement expects that the signal generator to be turned off and checks whether no signal power is detected at the RF In port of the analyzer beyond a certain threshold. All scalar results and traces are invalid in this mode. Even if the instrument noise floor is previously calibrated, the measurement performs all the required acquisitions and overwrites any pre-existing noise floor calibration data.

Returns:

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

Return type:

int

configure_noise_compensation_enabled(selector_string, noise_compensation_enabled)[source]

Configures whether to enable EVM noise compensation for the ModAcc measurement.

**Supported devices: **PXIe-5830/5831/5832/5646/5840/5841/5842/5860.

Parameters:

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

  • noise_compensation_enabled (enums.ModAccNoiseCompensationEnabled, int) –

    This parameter specifies whether the contribution of the instrument noise is compensated for EVM computation. The default value is False.

    Name (Value)

    Description

    False (0)

    Disables instrument noise compensation for EVM results.

    True (1)

    Enables instrument noise compensation for EVM results.

Returns:

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

Return type:

int

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

Configures the reference waveform for the creation of reference data symbols for EVM computation.

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, in seconds.

  • dx (float) – This parameter specifies the sample duration, in seconds.

  • reference_waveform (numpy.complex64) – This parameter specifies the complex baseband samples, in volts.

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

Gets whether the auto_level() method should search for the optimum reference levels while allowing ADC overflow.

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 searching for the optimum reference levels while allowing ADC overflow.

True (1)

Enables searching for the optimum reference levels while allowing ADC overflow.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccAutoLevelAllowOverflow):

Specifies whether the auto_level() method should search for the optimum reference levels while allowing ADC overflow.

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]

Enables averaging for the 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):

Enables averaging for the 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 channel 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 Reference+Data.

Name (Value)

Description

Reference (0)

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

Reference+Data (1)

Both demodulation reference (DMRS) and data symbols are used to calculate channel coefficients. This method is as per definition of 3GPP NR specification.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccChannelEstimationType):

Specifies the method used for channel 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_common_clock_source_enabled(selector_string)[source]

Gets whether same reference clock is used for local oscillator and digital-to-analog converter. When same reference clock is used the Carrier Frequency Offset is proportional to Sample Clock Error.

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 same reference clock is used for local oscillator and digital-to-analog converter. When 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_composite_results_include_dmrs(selector_string)[source]

Gets whether the DMRS resource elements are included for composite EVM and magnitude and phase error results and traces.

When using downlink test models, the DMRS resource elements are not included in composite results by default.

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 DMRS resource elements are not included.

True (1)

The DMRS resource elements are included.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccCompositeResultsIncludeDmrs):

Specifies whether the DMRS resource elements are included for composite EVM and magnitude and phase error results and traces.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_composite_results_include_ptrs(selector_string)[source]

Gets whether the PTRS resource elements are included for composite EVM and magnitude and phase error results and traces.

When using downlink test models, the PTRS resource elements are not included in composite results by default.

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 PTRS resource elements are not included.

True (1)

The PTRS resource elements are included.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccCompositeResultsIncludePtrs):

Specifies whether the PTRS resource elements are included for composite EVM and magnitude and phase error results and traces.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_dc_subcarrier_removal_enabled(selector_string)[source]

Gets whether the DC subcarrier is removed from 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 True.

Name (Value)

Description

False (0)

The DC subcarrier is present in the EVM results.

True (1)

The DC subcarrier is removed from the EVM results.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccDCSubcarrierRemovalEnabled):

Specifies whether the DC subcarrier is removed from 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_reference_data_symbols_mode(selector_string)[source]

Gets whether to either use a reference waveform or an acquired waveform to create reference data symbols for EVM computation.

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 Acquired Waveform.

Name (Value)

Description

Acquired Waveform (0)

Indicates that reference data symbols for EVM computation are created using the acquired waveform.

Reference Waveform (1)

Indicates that reference data symbols for EVM computation are created using the reference waveform.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccEvmReferenceDataSymbolsMode):

Specifies whether to either use a reference waveform or an acquired waveform to create reference data symbols for EVM computation.

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

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 range from -1 to 100, inclusive. When this attribute is set to -1, the measurement automatically sets the value of this attribute to the recommended value as specified in the Annexe F.5 of 3GPP TS 38.101-2 specification for uplink and Annexe B.5.2 and C.5.2 of 3GPP TS 38.104 specification for downlink.

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.

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 when MODACC_FFT_WINDOW_TYPE attribute is set to Custom. 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 when MODACC_FFT_WINDOW_TYPE attribute is set to Custom. 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 EVM calculation.

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

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 EVM calculation.

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.

If frequency error is absent in the signal to be analyzed, you may disable frequency estimation to reduce measurement time or to avoid measurement inaccuracy due to error in 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

Disabled (0)

Frequency error estimation and correction is disabled.

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

Gets the I/Q impairments model used by the measurement for estimating I/Q impairments.

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

Name (Value)

Description

Tx (0)

The measurement assumes that the I/Q impairments are introduced by a transmit DUT.

Rx (1)

The measurement assumes that the I/Q impairments are introduced by a receive DUT.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccIQImpairmentsModel):

Specifies the I/Q impairments model used by the measurement for estimating I/Q impairments.

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

Gets whether to return I/Q impairments independently for each subcarrier.

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)

Indicates that the independent estimation of I/Q impairments for each subcarrier is disabled.

True (1)

Indicates that the independent estimation of I/Q impairments for each subcarrier is enabled.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccIQImpairmentsPerSubcarrierEnabled):

Specifies whether to return I/Q impairments independently for each subcarrier.

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 the IQ impairments such as IQ gain imbalance and quadrature skew.

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 Impairments estimation is disabled.

True (1)

IQ Impairments estimation is enabled.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccIQMismatchEstimationEnabled):

Specifies whether to estimate the IQ impairments such as IQ gain imbalance and quadrature 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 the IQ origin offset.

If IQ origin offset is absent in the signal to be analyzed, you may disable IQ origin offset estimation to reduce measurement time or to avoid measurement inaccuracy due to error in IQ origin offset 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)

Indicates that IQ origin offset estimation and correction is disabled.

True (1)

Indicates that 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 the 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_magnitude_and_phase_error_enabled(selector_string)[source]

Gets whether to measure the magnitude and the phase error.

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)

Indicates that magnitude error and phase error results computation is disabled.

True (1)

Indicates that magnitude error and phase error results computation is enabled.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccMagnitudeAndPhaseErrorEnabled):

Specifies whether to measure the magnitude and the phase 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_measurement_enabled(selector_string)[source]

Gets whether to enable the ModAcc measurement.

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

The default value is FALSE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (bool):

Specifies whether to enable the ModAcc measurement.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_measurement_length(selector_string)[source]

Gets the measurement length in units specified by MODACC_MEASUREMENT_LENGTH_UNIT 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 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the measurement length in units specified by MODACC_MEASUREMENT_LENGTH_UNIT 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_measurement_length_unit(selector_string)[source]

Gets the units in which measurement offset and measurement length are specified.

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

The default value is Slot.

Name (Value)

Description

Slot (1)

Measurement offset and measurement length are specified in units of slots.

Subframe (3)

Measurement offset and measurement length are specified in units of subframes.

Time (6)

Measurement offset and measurement length are specified in seconds. Specify the measurement offset and length in multiples of 1 ms * (15 kHz/minimum subcarrier spacing of all carriers). All slots within this notional time duration are analysed.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccMeasurementLengthUnit):

Specifies the units in which measurement offset and measurement length are specified.

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

Gets whether the measurement should calibrate the noise floor of the analyzer or perform 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 Measure.

Name (Value)

Description

Measure (0)

The ModAcc measurement is performed on the acquired signal.

Calibrate Noise Floor (1)

The ModAcc measurement measures the noise floor of the instrument across the frequency determined by the carrier frequency and the channel bandwidth. In this mode, the measurement expects the signal generator to be turned off and checks if there is any signal power detected at RFIn port of the analyzer beyond a certain threshold. All scalar results and traces are invalid in this mode. Even if the instrument noise floor is already calibrated, the measurement performs all the required acquisitions and overwrites any pre-existing noise floor calibration data.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccMeasurementMode):

Specifies whether the measurement should calibrate the noise floor of the analyzer or perform 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. The synchronization boundary is specified by the MODACC_SYNCHRONIZATION_MODE attribute. The unit for this is specified by MODACC_MEASUREMENT_LENGTH_UNIT.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the measurement offset to skip from the synchronization boundary. The synchronization boundary is specified by the MODACC_SYNCHRONIZATION_MODE attribute. The unit for this is specified by MODACC_MEASUREMENT_LENGTH_UNIT.

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 the filter in single carrier configurations to minimize leakage into the carrier. Measurement ignores this attribute, if number of carriers is set to more than 1 or if you set the ACQUISITION_BANDWIDTH_OPTIMIZATION_ENABLED attribute to False, where in the multi carrier filter will always be used.

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)

Measurement doesn’t use the filter.

True (1)

Measurement filters out unwanted emissions.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccMulticarrierFilterEnabled):

Specifies whether to use the filter in single carrier configurations to minimize leakage into the carrier. Measurement ignores this attribute, if number of carriers is set to more than 1 or if you set the ACQUISITION_BANDWIDTH_OPTIMIZATION_ENABLED attribute to False, where in the multi carrier filter will always be used.

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

Gets whether the contribution of the instrument noise is compensated for EVM computation. You must measure the noise floor before applying the noise compensation. The instrument noise floor is measured for the RF path used by the ModAcc measurement and cached for future use.

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.

Supported devices are NI 5831 and NI 5840/41. The default value is False.

Name (Value)

Description

False (0)

Noise compensation is disabled for the measurement.

True (1)

Noise compensation is enabled for the measurement.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccNoiseCompensationEnabled):

Specifies whether the contribution of the instrument noise is compensated for EVM computation. You must measure the noise floor before applying the noise compensation. The instrument noise floor is measured for the RF path used by the ModAcc measurement and cached for future use.

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

Gets whether the measurement checks if any high power signal is present at the RFIn port of the instrument while performing noise floor calibration.

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 input power check at the RFIn port of the signal analyzer.

True (1)

Enables the input power check at the RFIn port of the signal analyzer.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccNoiseCompensationInputPowerCheckEnabled):

Specifies whether the measurement checks if any high power signal is present at the RFIn port of the instrument while performing noise floor calibration.

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

Gets the coercion limit for the reference level for noise compensation. When you set MODACC_MEASUREMENT_MODE attribute to Measure and MODACC_NOISE_COMPENSATION_ENABLED attribute to True, the measurement attempts to read noise floor calibration data corresponding to the configured reference level.

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.

If noise floor calibration data corresponding to the configured reference level is not found in the calibration database, the measurement attempts to read noise floor calibration data from the calibration database for any reference level in the range of the configured reference level plus the coercion limit you set for this attribute. The default value is 0.5.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the coercion limit for the reference level for noise compensation. When you set MODACC_MEASUREMENT_MODE attribute to Measure and MODACC_NOISE_COMPENSATION_ENABLED attribute to True, the measurement attempts to read noise floor calibration data corresponding to the configured reference level.

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.

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

Gets the method used for phase tracking.

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

Disabled (0)

Disables the phase tracking.

Reference+Data (1)

All reference and data symbols are used for phase tracking.

PTRS (2)

Only PTRS symbols are used for phase tracking.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccPhaseTrackingMode):

Specifies the method used for phase tracking.

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.

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.

Measurement Length (1)

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

Gets whether the input signal has a periodicity shorter than the NR frame duration.

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)

When you set the attribute to False or the Trigger Type attribute is set to a value other than None, a signal periodicity equal to the maximum of 1 frame duration and the configured SSB periodicity, if SSB is active, is assumed.

True (1)

When you set the attribute to False or the Trigger Type attribute is set to None, the measurement uses ModAcc Short Frame Length as signal periodicity.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccShortFrameEnabled):

Specifies whether the input signal has a periodicity shorter than the NR frame duration.

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

Gets the short frame periodicity in unit specified by MODACC_SHORT_FRAME_LENGTH_UNIT.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the short frame periodicity in unit specified by MODACC_SHORT_FRAME_LENGTH_UNIT.

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

Gets the units in which MODACC_SHORT_FRAME_LENGTH_UNIT is specified.

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

Name (Value)

Description

Slot (1)

Short frame length is specified in units of slots.

Subframe (3)

Short frame length is specified in units of subframes.

Time (6)

Short frame length is specified in units of time.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccShortFrameLengthUnit):

Specifies the units in which MODACC_SHORT_FRAME_LENGTH_UNIT is specified.

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 test condition for Spectral Flatness 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 Normal.

Name (Value)

Description

Normal (0)

Frequency range and maximum ripple defined in the section 6.4.2.4.1, Table 6.4.2.4.1-1 of 3GPP 38.101-1 and section 6.4.2.4.1, Table 6.4.2.4.1-1 of 3GPP 38.101-2 are used.

Extreme (1)

Frequency range and maximum ripple defined in the section 6.4.2.4.1, Table 6.4.2.4.1-2 of 3GPP 38.101-1 and section 6.4.2.4.1, Table 6.4.2.4.1-2 of 3GPP 38.101-2 are used.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccSpectralFlatnessCondition):

Specifies the test condition for Spectral Flatness measurement.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_spectrum_inverted(selector_string)[source]

Gets whether the spectrum of the signal being measured is inverted. This happens when I and Q component of the baseband complex signal is 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 signal being measured is not inverted.

True (1)

The signal being measured is inverted and measurement will correct it by swapping the I and Q components.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccSpectrumInverted):

Specifies whether the spectrum of the signal being measured is inverted. This happens when I and Q component of the baseband complex signal is 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.

This attribute is ignored when the MODACC_COMMON_CLOCK_SOURCE_ENABLED attribute is True and the MODACC_FREQUENCY_ERROR_ESTIMATION attribute is Disabled, in which case, symbol clock error is not estimated.

If symbol clock error is absent in the signal to be analyzed, you may disable symbol clock error estimation 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)

Indicates that symbol clock error estimation and correction is disabled.

True (1)

Indicates that 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 slot or frame 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

Slot (1)

The measurement is performed over the ModAcc Meas Length starting at the ModAcc Meas Offset from the slot boundary. If you set the Trigger Type attribute to Digital Edge, the measurement expects the digital trigger at the slot boundary.

Frame (5)

The measurement is performed over the ModAcc Meas Length starting at ModAcc Meas Offset from the frame boundary. If you set the Trigger Type attribute to Digital Edge, the measurement expects the digital trigger from the frame boundary.

SSB Start Frame (7)

The measurement is performed over the ModAcc Meas Length starting at ModAcc Meas Offset from the frame boundary. If you set the Trigger Type attribute to Digital Edge, the measurement expects the digital trigger from the boundary of the frame having SSB.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccSynchronizationMode):

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

Gets the method used for timing tracking.

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

Disabled (0)

Disables the timing tracking.

Reference+Data (1)

All reference and data symbols are used for timing tracking.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccTimingTrackingMode):

Specifies the method used for timing tracking.

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

It configures the transient duration as specified in section 6.4.2.1a of 3GPP 38.101-1 specification.

If MODACC_TRANSIENT_PERIOD_EVM_MODE is set to Include, configures the transient duration to calculate FFT window positions used to compute the transient EVM as specified in section 6.4.2.1a of 3GPP 38.101-1 specification.

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 2us.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

It configures the transient duration as specified in section 6.4.2.1a of 3GPP 38.101-1 specification.

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

Configures the EVM measurement behavior for symbols affected by power transients.

According to 3GPP 38.101-1 Rel. 17.6 transient EVM measurement (i.e. Transient Period EVM Mode set to Include) is applicable when LINK_DIRECTION is set to Uplink, FREQUENCY_RANGE is set to Range 1, PUSCH_TRANSFORM_PRECODING_ENABLED is set to False, and BANDWIDTH_PART_SUBCARRIER_SPACING is set to 15kHz or 30kHz.

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

Name (Value)

Description

Disabled (0)

No special treatment of transient symbols (old behavior).

Exclude (1)

Transient symbols are not considered for EVM computation.

Include (2)

Transient EVM measurement definition is applied to transient symbols and returned as a separate Transient RMS EVM result.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccTransientPeriodEvmMode):

Configures the EVM measurement behavior for symbols affected by power transients.

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

Gets transient period power change threshold level in dB.

If a mean slot power has changed by more than this value from one slot to another, this slot boundary is handled as transient period. Note also that if RB mapping or modulation format has changed from one slot to another, this slot boundary is handled as transient period as well, even though the mean power has not changed.

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 (float):

Specifies transient period power change threshold level in dB.

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

Sets whether the auto_level() method should search for the optimum reference levels while allowing ADC overflow.

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 searching for the optimum reference levels while allowing ADC overflow.

True (1)

Enables searching for the optimum reference levels while allowing ADC overflow.
Parameters:
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]

Enables averaging for the 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:
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 channel 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 Reference+Data.

Name (Value)

Description

Reference (0)

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

Reference+Data (1)

Both demodulation reference (DMRS) and data symbols are used to calculate channel coefficients. This method is as per definition of 3GPP NR specification.
Parameters:
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 same reference clock is used for local oscillator and digital-to-analog converter. When same reference clock is used the Carrier Frequency Offset is proportional to Sample Clock Error.

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 same reference clock is used for local oscillator and digital-to-analog converter. When 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_composite_results_include_dmrs(selector_string, value)[source]

Sets whether the DMRS resource elements are included for composite EVM and magnitude and phase error results and traces.

When using downlink test models, the DMRS resource elements are not included in composite results by default.

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 DMRS resource elements are not included.

True (1)

The DMRS resource elements are included.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccCompositeResultsIncludeDmrs, int) – Specifies whether the DMRS resource elements are included for composite EVM and magnitude and phase error results and traces.

Returns:

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

Return type:

int

set_composite_results_include_ptrs(selector_string, value)[source]

Sets whether the PTRS resource elements are included for composite EVM and magnitude and phase error results and traces.

When using downlink test models, the PTRS resource elements are not included in composite results by default.

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 PTRS resource elements are not included.

True (1)

The PTRS resource elements are included.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccCompositeResultsIncludePtrs, int) – Specifies whether the PTRS resource elements are included for composite EVM and magnitude and phase error results and traces.

Returns:

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

Return type:

int

set_dc_subcarrier_removal_enabled(selector_string, value)[source]

Sets whether the DC subcarrier is removed from 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 True.

Name (Value)

Description

False (0)

The DC subcarrier is present in the EVM results.

True (1)

The DC subcarrier is removed from the EVM results.
Parameters:
Returns:

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

Return type:

int

set_evm_reference_data_symbols_mode(selector_string, value)[source]

Sets whether to either use a reference waveform or an acquired waveform to create reference data symbols for EVM computation.

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 Acquired Waveform.

Name (Value)

Description

Acquired Waveform (0)

Indicates that reference data symbols for EVM computation are created using the acquired waveform.

Reference Waveform (1)

Indicates that reference data symbols for EVM computation are created using the reference waveform.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccEvmReferenceDataSymbolsMode, int) – Specifies whether to either use a reference waveform or an acquired waveform to create reference data symbols for EVM computation.

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

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 range from -1 to 100, inclusive. When this attribute is set to -1, the measurement automatically sets the value of this attribute to the recommended value as specified in the Annexe F.5 of 3GPP TS 38.101-2 specification for uplink and Annexe B.5.2 and C.5.2 of 3GPP TS 38.104 specification for downlink.

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.

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 when MODACC_FFT_WINDOW_TYPE attribute is set to Custom. 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 when MODACC_FFT_WINDOW_TYPE attribute is set to Custom. 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 EVM calculation.

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

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 EVM calculation.

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.

If frequency error is absent in the signal to be analyzed, you may disable frequency estimation to reduce measurement time or to avoid measurement inaccuracy due to error in 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

Disabled (0)

Frequency error estimation and correction is disabled.

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

Sets the I/Q impairments model used by the measurement for estimating I/Q impairments.

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

Name (Value)

Description

Tx (0)

The measurement assumes that the I/Q impairments are introduced by a transmit DUT.

Rx (1)

The measurement assumes that the I/Q impairments are introduced by a receive DUT.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccIQImpairmentsModel, int) – Specifies the I/Q impairments model used by the measurement for estimating I/Q impairments.

Returns:

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

Return type:

int

set_iq_impairments_per_subcarrier_enabled(selector_string, value)[source]

Sets whether to return I/Q impairments independently for each subcarrier.

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)

Indicates that the independent estimation of I/Q impairments for each subcarrier is disabled.

True (1)

Indicates that the independent estimation of I/Q impairments for each subcarrier 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 the IQ impairments such as IQ gain imbalance and quadrature skew.

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 Impairments estimation is disabled.

True (1)

IQ Impairments 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 the IQ origin offset.

If IQ origin offset is absent in the signal to be analyzed, you may disable IQ origin offset estimation to reduce measurement time or to avoid measurement inaccuracy due to error in IQ origin offset 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)

Indicates that IQ origin offset estimation and correction is disabled.

True (1)

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

Sets whether to measure the magnitude and the phase error.

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)

Indicates that magnitude error and phase error results computation is disabled.

True (1)

Indicates that magnitude error and phase error results computation 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 measurement length in units specified by MODACC_MEASUREMENT_LENGTH_UNIT 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 1.

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

Sets the units in which measurement offset and measurement length are specified.

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

The default value is Slot.

Name (Value)

Description

Slot (1)

Measurement offset and measurement length are specified in units of slots.

Subframe (3)

Measurement offset and measurement length are specified in units of subframes.

Time (6)

Measurement offset and measurement length are specified in seconds. Specify the measurement offset and length in multiples of 1 ms * (15 kHz/minimum subcarrier spacing of all carriers). All slots within this notional time duration are analysed.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccMeasurementLengthUnit, int) – Specifies the units in which measurement offset and measurement length are specified.

Returns:

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

Return type:

int

set_measurement_mode(selector_string, value)[source]

Sets whether the measurement should calibrate the noise floor of the analyzer or perform 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 Measure.

Name (Value)

Description

Measure (0)

The ModAcc measurement is performed on the acquired signal.

Calibrate Noise Floor (1)

The ModAcc measurement measures the noise floor of the instrument across the frequency determined by the carrier frequency and the channel bandwidth. In this mode, the measurement expects the signal generator to be turned off and checks if there is any signal power detected at RFIn port of the analyzer beyond a certain threshold. All scalar results and traces are invalid in this mode. Even if the instrument noise floor is already calibrated, the measurement performs all the required acquisitions and overwrites any pre-existing noise floor calibration data.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccMeasurementMode, int) – Specifies whether the measurement should calibrate the noise floor of the analyzer or perform 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. The synchronization boundary is specified by the MODACC_SYNCHRONIZATION_MODE attribute. The unit for this is specified by MODACC_MEASUREMENT_LENGTH_UNIT.

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

The default value is 0.

Parameters:
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 the filter in single carrier configurations to minimize leakage into the carrier. Measurement ignores this attribute, if number of carriers is set to more than 1 or if you set the ACQUISITION_BANDWIDTH_OPTIMIZATION_ENABLED attribute to False, where in the multi carrier filter will always be used.

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)

Measurement doesn’t use the filter.

True (1)

Measurement filters out unwanted emissions.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccMulticarrierFilterEnabled, int) – Specifies whether to use the filter in single carrier configurations to minimize leakage into the carrier. Measurement ignores this attribute, if number of carriers is set to more than 1 or if you set the ACQUISITION_BANDWIDTH_OPTIMIZATION_ENABLED attribute to False, where in the multi carrier filter will always be used.

Returns:

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

Return type:

int

set_noise_compensation_enabled(selector_string, value)[source]

Sets whether the contribution of the instrument noise is compensated for EVM computation. You must measure the noise floor before applying the noise compensation. The instrument noise floor is measured for the RF path used by the ModAcc measurement and cached for future use.

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.

Supported devices are NI 5831 and NI 5840/41. The default value is False.

Name (Value)

Description

False (0)

Noise compensation is disabled for the measurement.

True (1)

Noise compensation is enabled for the measurement.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccNoiseCompensationEnabled, int) – Specifies whether the contribution of the instrument noise is compensated for EVM computation. You must measure the noise floor before applying the noise compensation. The instrument noise floor is measured for the RF path used by the ModAcc measurement and cached for future use.

Returns:

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

Return type:

int

set_noise_compensation_input_power_check_enabled(selector_string, value)[source]

Sets whether the measurement checks if any high power signal is present at the RFIn port of the instrument while performing noise floor calibration.

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 input power check at the RFIn port of the signal analyzer.

True (1)

Enables the input power check at the RFIn port of the signal analyzer.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccNoiseCompensationInputPowerCheckEnabled, int) – Specifies whether the measurement checks if any high power signal is present at the RFIn port of the instrument while performing noise floor calibration.

Returns:

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

Return type:

int

set_noise_compensation_reference_level_coercion_limit(selector_string, value)[source]

Sets the coercion limit for the reference level for noise compensation. When you set MODACC_MEASUREMENT_MODE attribute to Measure and MODACC_NOISE_COMPENSATION_ENABLED attribute to True, the measurement attempts to read noise floor calibration data corresponding to the configured reference level.

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.

If noise floor calibration data corresponding to the configured reference level is not found in the calibration database, the measurement attempts to read noise floor calibration data from the calibration database for any reference level in the range of the configured reference level plus the coercion limit you set for this attribute. The default value is 0.5.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the coercion limit for the reference level for noise compensation. When you set MODACC_MEASUREMENT_MODE attribute to Measure and MODACC_NOISE_COMPENSATION_ENABLED attribute to True, the measurement attempts to read noise floor calibration data corresponding to the configured reference level.

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.

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

Sets the method used for phase tracking.

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

Disabled (0)

Disables the phase tracking.

Reference+Data (1)

All reference and data symbols are used for phase tracking.

PTRS (2)

Only PTRS 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.

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.

Measurement Length (1)

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

Sets whether the input signal has a periodicity shorter than the NR frame duration.

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)

When you set the attribute to False or the Trigger Type attribute is set to a value other than None, a signal periodicity equal to the maximum of 1 frame duration and the configured SSB periodicity, if SSB is active, is assumed.

True (1)

When you set the attribute to False or the Trigger Type attribute is set to None, the measurement uses ModAcc Short Frame Length as signal periodicity.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccShortFrameEnabled, int) – Specifies whether the input signal has a periodicity shorter than the NR frame duration.

Returns:

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

Return type:

int

set_short_frame_length(selector_string, value)[source]

Sets the short frame periodicity in unit specified by MODACC_SHORT_FRAME_LENGTH_UNIT.

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

Parameters:
Returns:

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

Return type:

int

set_short_frame_length_unit(selector_string, value)[source]

Sets the units in which MODACC_SHORT_FRAME_LENGTH_UNIT is specified.

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

Name (Value)

Description

Slot (1)

Short frame length is specified in units of slots.

Subframe (3)

Short frame length is specified in units of subframes.

Time (6)

Short frame length is specified in units of time.
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 test condition for Spectral Flatness 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 Normal.

Name (Value)

Description

Normal (0)

Frequency range and maximum ripple defined in the section 6.4.2.4.1, Table 6.4.2.4.1-1 of 3GPP 38.101-1 and section 6.4.2.4.1, Table 6.4.2.4.1-1 of 3GPP 38.101-2 are used.

Extreme (1)

Frequency range and maximum ripple defined in the section 6.4.2.4.1, Table 6.4.2.4.1-2 of 3GPP 38.101-1 and section 6.4.2.4.1, Table 6.4.2.4.1-2 of 3GPP 38.101-2 are used.
Parameters:
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 being measured is inverted. This happens when I and Q component of the baseband complex signal is 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 signal being measured is not inverted.

True (1)

The signal being measured is inverted and measurement will correct it by swapping the I and Q components.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccSpectrumInverted, int) – Specifies whether the spectrum of the signal being measured is inverted. This happens when I and Q component of the baseband complex signal is 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.

This attribute is ignored when the MODACC_COMMON_CLOCK_SOURCE_ENABLED attribute is True and the MODACC_FREQUENCY_ERROR_ESTIMATION attribute is Disabled, in which case, symbol clock error is not estimated.

If symbol clock error is absent in the signal to be analyzed, you may disable symbol clock error estimation 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)

Indicates that symbol clock error estimation and correction is disabled.

True (1)

Indicates that 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 slot or frame 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

Slot (1)

The measurement is performed over the ModAcc Meas Length starting at the ModAcc Meas Offset from the slot boundary. If you set the Trigger Type attribute to Digital Edge, the measurement expects the digital trigger at the slot boundary.

Frame (5)

The measurement is performed over the ModAcc Meas Length starting at ModAcc Meas Offset from the frame boundary. If you set the Trigger Type attribute to Digital Edge, the measurement expects the digital trigger from the frame boundary.

SSB Start Frame (7)

The measurement is performed over the ModAcc Meas Length starting at ModAcc Meas Offset from the frame boundary. If you set the Trigger Type attribute to Digital Edge, the measurement expects the digital trigger from the boundary of the frame having SSB.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccSynchronizationMode, int) – Specifies whether the measurement is performed from slot or frame 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_mode(selector_string, value)[source]

Sets the method used for timing tracking.

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

Disabled (0)

Disables the timing tracking.

Reference+Data (1)

All 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

set_transient_period(selector_string, value)[source]

It configures the transient duration as specified in section 6.4.2.1a of 3GPP 38.101-1 specification.

If MODACC_TRANSIENT_PERIOD_EVM_MODE is set to Include, configures the transient duration to calculate FFT window positions used to compute the transient EVM as specified in section 6.4.2.1a of 3GPP 38.101-1 specification.

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 2us.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – It configures the transient duration as specified in section 6.4.2.1a of 3GPP 38.101-1 specification.

Returns:

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

Return type:

int

set_transient_period_evm_mode(selector_string, value)[source]

Configures the EVM measurement behavior for symbols affected by power transients.

According to 3GPP 38.101-1 Rel. 17.6 transient EVM measurement (i.e. Transient Period EVM Mode set to Include) is applicable when LINK_DIRECTION is set to Uplink, FREQUENCY_RANGE is set to Range 1, PUSCH_TRANSFORM_PRECODING_ENABLED is set to False, and BANDWIDTH_PART_SUBCARRIER_SPACING is set to 15kHz or 30kHz.

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

Name (Value)

Description

Disabled (0)

No special treatment of transient symbols (old behavior).

Exclude (1)

Transient symbols are not considered for EVM computation.

Include (2)

Transient EVM measurement definition is applied to transient symbols and returned as a separate Transient RMS EVM result.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccTransientPeriodEvmMode, int) – Configures the EVM measurement behavior for symbols affected by power transients.

Returns:

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

Return type:

int

set_transient_power_change_threshold(selector_string, value)[source]

Sets transient period power change threshold level in dB.

If a mean slot power has changed by more than this value from one slot to another, this slot boundary is handled as transient period. Note also that if RB mapping or modulation format has changed from one slot to another, this slot boundary is handled as transient period as well, even though the mean power has not changed.

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 (float) – Specifies transient period power change threshold level in dB.

Returns:

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

Return type:

int

validate_calibration_data(selector_string)[source]

Specifies whether calibration data is valid for the configuration specified by the signal name in the Selector String parameter.

Parameters:

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

Returns:

calibration_data_valid (enums.ModAccCalibrationDataValid):

This parameter returns whether the calibration data is valid.

Name (Value)

Description

False (0)

Returns false if the calibration data is not present for the specified configuration or if the difference between the current device temperature and the calibration temperature exceeds the [-5 °C, 5 °C] range.

True (1)

Returns true if the calibration data is present for the configuration specified by the signal name in the Selector String parameter.
error_code (int):

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

Return type:

Tuple (calibration_data_valid, error_code)