ModAccConfiguration

Provides methods to configure the ModAcc measurement.

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

Bases: object

Provides methods to configure the ModAcc measurement.

configure_averaging(selector_string, averaging_enabled, averaging_count)[source]

Configures averaging for the modulation accuracy (ModAcc) measurement.

Parameters:

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

  • averaging_enabled (enums.ModAccAveragingEnabled, int) –

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

    Name (Value)

    Description

    False (0)

    The measurement is performed on a single acquisition.

    True (1)

    The measurement is averaged over multiple acquisitions.

  • averaging_count (int) – This parameter specifies the number of acquisitions used for averaging when you set the Averaging Enabled parameter to True. The default value is 10.

Returns:

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

Return type:

int

configure_droop_compensation_enabled(selector_string, droop_compensation_enabled)[source]

Configures whether to enable droop compensation for the modulation accuracy (ModAcc) measurement.

Parameters:

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

  • droop_compensation_enabled (enums.ModAccDroopCompensationEnabled, int) –

    This parameter specifies whether to enable droop compensation for the ModAcc measurement. Droop compensation allows the ModAcc measurement to minimize the contribution of amplifier power variations to the EVM results. The default value is False.

    Name (Value)

    Description

    False (0)

    Disables the power droop compensation in the EVM measurement.

    True (1)

    Enables the power droop compensation in the EVM measurement.

Returns:

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

Return type:

int

get_all_traces_enabled(selector_string)[source]

Gets whether to enable the traces to be stored and retrieved after performing the modulation accuracy (ModAcc) measurement.

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

The default value is FALSE.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (bool):

Specifies whether to enable the traces to be stored and retrieved after performing the modulation accuracy (ModAcc) measurement.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_averaging_count(selector_string)[source]

Gets the number of acquisitions used for averaging when you set the MODACC_AVERAGING_ENABLED attribute to True.

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

The default value is 10.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of acquisitions used for averaging when you set the MODACC_AVERAGING_ENABLED attribute to True.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_averaging_enabled(selector_string)[source]

Gets whether to enable averaging for the modulation accuracy (ModAcc) measurement.

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

The default value is False.

Name (Value)

Description

False (0)

The measurement is performed on a single acquisition.

True (1)

The measurement is averaged over multiple acquisitions.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccAveragingEnabled):

Specifies whether to enable averaging for the modulation accuracy (ModAcc) measurement.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_droop_compensation_enabled(selector_string)[source]

Gets whether to enable droop compensation for the modulation accuracy (ModAcc) measurement. Droop compensation allows the ModAcc measurement to minimize the contribution of amplifier power variations to 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 False.

Name (Value)

Description

False (0)

Disables power droop compensation in the EVM measurement.

True (1)

Enables power droop compensation in the EVM measurement.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccDroopCompensationEnabled):

Specifies whether to enable droop compensation for the modulation accuracy (ModAcc) measurement. Droop compensation allows the ModAcc measurement to minimize the contribution of amplifier power variations to 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_measurement_enabled(selector_string)[source]

Gets whether to enable modulation accuracy (ModAcc) measurements on the acquired signal.

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 modulation accuracy (ModAcc) measurements on the acquired signal.

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

Gets whether the measurement is performed on a single specified timeslot or across multiple timeslots.

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 ‘Number of Timeslots’.

Name (Value)

Description

Number of Timeslots (0)

The measurement includes all timeslots defined by the Num Timeslots attribute.

Timeslot at Offset (1)

The measurement is performed only on the timeslot specified by the ModAcc Meas Offset attribute. This attribute is applicable only when you set the Trigger Type attribute to IQ Power Edge or **Digital Edge **.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ModAccMeasurementInterval):

Specifies whether the measurement is performed on a single specified timeslot or across multiple timeslots.

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 offset, relative to the trigger of the timeslot to be measured.

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

The default value is 0. Valid values are [0, (NUMBER_OF_TIMESLOTS -1)].

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the offset, relative to the trigger of the timeslot to be measured.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_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)

set_all_traces_enabled(selector_string, value)[source]

Sets whether to enable the traces to be stored and retrieved after performing the modulation accuracy (ModAcc) measurement.

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

The default value is FALSE.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (bool) – Specifies whether to enable the traces to be stored and retrieved after performing the modulation accuracy (ModAcc) measurement.

Returns:

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

Return type:

int

set_averaging_count(selector_string, value)[source]

Sets the number of acquisitions used for averaging when you set the MODACC_AVERAGING_ENABLED attribute to True.

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

The default value is 10.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the number of acquisitions used for averaging when you set the MODACC_AVERAGING_ENABLED attribute to True.

Returns:

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

Return type:

int

set_averaging_enabled(selector_string, value)[source]

Sets whether to enable averaging for the modulation accuracy (ModAcc) measurement.

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

The default value is False.

Name (Value)

Description

False (0)

The measurement is performed on a single acquisition.

True (1)

The measurement is averaged over multiple acquisitions.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccAveragingEnabled, int) – Specifies whether to enable averaging for the modulation accuracy (ModAcc) measurement.

Returns:

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

Return type:

int

set_droop_compensation_enabled(selector_string, value)[source]

Sets whether to enable droop compensation for the modulation accuracy (ModAcc) measurement. Droop compensation allows the ModAcc measurement to minimize the contribution of amplifier power variations to 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 False.

Name (Value)

Description

False (0)

Disables power droop compensation in the EVM measurement.

True (1)

Enables power droop compensation in the EVM measurement.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccDroopCompensationEnabled, int) – Specifies whether to enable droop compensation for the modulation accuracy (ModAcc) measurement. Droop compensation allows the ModAcc measurement to minimize the contribution of amplifier power variations to 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_measurement_enabled(selector_string, value)[source]

Sets whether to enable modulation accuracy (ModAcc) measurements on the acquired signal.

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 modulation accuracy (ModAcc) measurements on the acquired signal.

Returns:

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

Return type:

int

set_measurement_interval(selector_string, value)[source]

Sets whether the measurement is performed on a single specified timeslot or across multiple timeslots.

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 ‘Number of Timeslots’.

Name (Value)

Description

Number of Timeslots (0)

The measurement includes all timeslots defined by the Num Timeslots attribute.

Timeslot at Offset (1)

The measurement is performed only on the timeslot specified by the ModAcc Meas Offset attribute. This attribute is applicable only when you set the Trigger Type attribute to IQ Power Edge or **Digital Edge **.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ModAccMeasurementInterval, int) – Specifies whether the measurement is performed on a single specified timeslot or across multiple timeslots.

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 offset, relative to the trigger of the timeslot to be measured.

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

The default value is 0. Valid values are [0, (NUMBER_OF_TIMESLOTS -1)].

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the offset, relative to the trigger of the timeslot to be measured.

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