QevmConfiguration

Provides methods to configure the Qevm measurement.

class nirfmxcdma2k.qevm_configuration.QevmConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the Qevm measurement.

configure_averaging(selector_string, averaging_enabled, averaging_count)[source]

Configures averaging for QEVM 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.QevmAveragingEnabled, 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 QEVM measurement uses the Averaging Count parameter to calculate the number of acquisitions over which the QEVM measurement is averaged.

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

Configures the number of chips used for a single QEVM measurement iteration.

Parameters:

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

  • measurement_length (int) – This parameter specifies the number of chips used for a single measurement. The default value is 1536. The valid values range from 700 to 2500, inclusive.

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 QEVM 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 QEVM 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 measurements used for averaging when you set the QEVM_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 values is 10. The valid values are 1 to 10000, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of measurements used for averaging when you set the QEVM_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 QEVM 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 averaging is disabled for the measurement.

True (1)

The averaging is enabled for the measurement.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.QevmAveragingEnabled):

Specifies whether to enable averaging for the QEVM measurement.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_iq_gain_imbalance_removal_enabled(selector_string)[source]

Gets whether to remove I/Q gain imbalance before QEVM measurement.

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

The default value is False.

Name (Value)

Description

False (0)

I/Q gain imbalance is not removed before the QEVM measurement.

True (1)

I/Q gain imbalance is removed before the QEVM measurement.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.QevmIQGainImbalanceRemovalEnabled):

Specifies whether to remove I/Q gain imbalance before QEVM measurement.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_iq_offset_removal_enabled(selector_string)[source]

Gets whether to remove I/Q offset before QEVM measurement.

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

The default value is False.

Name (Value)

Description

False (0)

I/Q offset is not removed before the QEVM measurement.

True (1)

I/Q offset is removed before the QEVM measurement.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.QevmIQOffsetRemovalEnabled):

Specifies whether to remove I/Q offset before QEVM measurement.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_iq_quadrature_error_removal_enabled(selector_string)[source]

Gets whether to remove I/Q quadrature error before QEVM measurement.

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

The default value is False.

Name (Value)

Description

False (0)

I/Q quadrature error is not removed before the QEVM measurement.

True (1)

I/Q quadrature error is removed before the QEVM measurement.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.QevmIQQuadratureErrorRemovalEnabled):

Specifies whether to remove I/Q quadrature error before QEVM measurement.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_measurement_enabled(selector_string)[source]

Gets whether to enable the QEVM 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 QEVM measurement.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_measurement_length(selector_string)[source]

Gets the number of chips used for a single 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 1536. The valid values are 700 to 2500, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of chips used for a single 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_number_of_analysis_threads(selector_string)[source]

Gets the maximum number of threads used for parallelism for the QEVM 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.

The default value is 1. Valid values range from 0 to 10, inclusive.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the maximum number of threads used for parallelism for the QEVM 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_receive_filter_enabled(selector_string)[source]

Gets whether to enable the received filter for the QEVM 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 True.

Name (Value)

Description

False (0)

Disables received filtering for the QEVM measurement.

True (1)

Enables received filtering for the QEVM measurement.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.QevmReceiveFilterEnabled):

Specifies whether to enable the received filter for the QEVM 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 is inverted.

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

The default value is False.

Name (Value)

Description

False (0)

The measurement spectrum is normal.

True (1)

The measurement spectrum is inverted.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.QevmSpectrumInverted):

Specifies whether the spectrum of the signal is inverted.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

set_all_traces_enabled(selector_string, value)[source]

Sets whether to enable the traces to be stored and retrieved after performing the QEVM 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 QEVM 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 measurements used for averaging when you set the QEVM_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 values is 10. The valid values are 1 to 10000, inclusive.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the number of measurements used for averaging when you set the QEVM_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 QEVM 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 averaging is disabled for the measurement.

True (1)

The averaging is enabled for the measurement.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.QevmAveragingEnabled, int) – Specifies whether to enable averaging for the QEVM measurement.

Returns:

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

Return type:

int

set_iq_gain_imbalance_removal_enabled(selector_string, value)[source]

Sets whether to remove I/Q gain imbalance before QEVM measurement.

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

The default value is False.

Name (Value)

Description

False (0)

I/Q gain imbalance is not removed before the QEVM measurement.

True (1)

I/Q gain imbalance is removed before the QEVM measurement.
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_offset_removal_enabled(selector_string, value)[source]

Sets whether to remove I/Q offset before QEVM measurement.

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

The default value is False.

Name (Value)

Description

False (0)

I/Q offset is not removed before the QEVM measurement.

True (1)

I/Q offset is removed before the QEVM measurement.
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_removal_enabled(selector_string, value)[source]

Sets whether to remove I/Q quadrature error before QEVM measurement.

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

The default value is False.

Name (Value)

Description

False (0)

I/Q quadrature error is not removed before the QEVM measurement.

True (1)

I/Q quadrature error is removed before the QEVM measurement.
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 QEVM 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 QEVM measurement.

Returns:

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

Return type:

int

set_measurement_length(selector_string, value)[source]

Sets the number of chips used for a single 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 1536. The valid values are 700 to 2500, inclusive.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the number of chips used for a single measurement.

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

The default value is 1. Valid values range from 0 to 10, inclusive.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the maximum number of threads used for parallelism for the QEVM measurement.

Returns:

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

Return type:

int

set_receive_filter_enabled(selector_string, value)[source]

Sets whether to enable the received filter for the QEVM 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 True.

Name (Value)

Description

False (0)

Disables received filtering for the QEVM measurement.

True (1)

Enables received filtering for the QEVM measurement.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.QevmReceiveFilterEnabled, int) – Specifies whether to enable the received filter for the QEVM measurement.

Returns:

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

Return type:

int

set_spectrum_inverted(selector_string, value)[source]

Sets whether the spectrum of the signal is inverted.

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

The default value is False.

Name (Value)

Description

False (0)

The measurement spectrum is normal.

True (1)

The measurement spectrum is inverted.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.QevmSpectrumInverted, int) – Specifies whether the spectrum of the signal is inverted.

Returns:

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

Return type:

int