DsssModAccConfiguration

Provides methods to configure the DsssModAcc measurement.

class nirfmxwlan.dsssmodacc_configuration.DsssModAccConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the DsssModAcc measurement.

configure_acquisition_length(selector_string, acquisition_length_mode, acquisition_length)[source]

Configures the Acquisition Length parameter and the Acquisition Length Mode parameter of the acquired waveform for the measurement.

Parameters:

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

  • acquisition_length_mode (enums.DsssModAccAcquisitionLengthMode, int) –

    This parameter specifies whether the measurement automatically computes the acquisition length of the waveform based on DSSSModAcc attributes. The default value is Auto.

    Name (Value)

    Description

    Manual (0)

    Uses the acquisition length specified by the Acquisition Length parameter.

    Auto (1)

    Computes the acquisition length based on the DSSSModAcc Meas Offset attribute and the DSSSModAcc Max Meas Length attribute.

  • acquisition_length (float) – This parameter specifies the length of the waveform to be acquired for the DSSSModAcc measurement when you set the Acquisition Length Mode parameter to Manual. This value is expressed in seconds. The default value is 0.001.

Returns:

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

Return type:

int

configure_averaging(selector_string, averaging_enabled, averaging_count)[source]

Configures averaging for the 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.DsssModAccAveragingEnabled, int) –

    This parameter specifies whether to enable averaging for DSSSModAcc measurements. The default value is False.

    Name (Value)

    Description

    False (0)

    The measurement is performed on a single acquisition.

    True (1)

    The measurement uses the Averaging Count parameter as the number of acquisitions over which the results are 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_evm_unit(selector_string, evm_unit)[source]

Configures EVM unit for the measurement.

Parameters:

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

  • evm_unit (enums.DsssModAccEvmUnit, int) –

    This parameter specifies the unit for the EVM results. The default value is Percentage.

    Name (Value)

    Description

    dB (0)

    EVM results are returned in dB.

    Percentage (1)

    EVM results are returned as a percentage.

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_offset, maximum_measurement_length)[source]

Configures the measurement offset and the maximum measurement length for the DSSSModAcc measurement.

Parameters:

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

  • measurement_offset (int) – This parameter specifies the number of data chips to be ignored from the start of the data field for the EVM computation. This value is expressed in chips. The default value is 0.

  • maximum_measurement_length (int) – This parameter specifies the maximum number of data chips that the measurement uses to compute EVM. This value is expressed in chips. The default value is 1000.

Returns:

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

Return type:

int

configure_power_measurement_custom_gate_array(selector_string, start_time, stop_time)[source]

Configures the custom gate start and stop times for power measurement.

Parameters:

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

  • start_time (float) – This parameter specifies the array of start time of the custom power gates. This value is expressed in seconds. A value of 0 indicates that the start time is the start of the PPDU. The default value is an empty array.

  • stop_time (float) – This parameter specifies the array of stop time of the custom power gates. This value is expressed in seconds. The default value is an empty array.

Returns:

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

Return type:

int

configure_power_measurement_enabled(selector_string, power_measurement_enabled)[source]

Configures whether power measurement is enabled for the DSSSModAcc measurement.

Parameters:

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

  • power_measurement_enabled (enums.DsssModAccPowerMeasurementEnabled, int) –

    This parameter specifies if power measurement is performed. This parameter computes power of various fields in the PPDU. Additionally, this measurement computes power over the custom gates that you can configure using the POWER_NUMBER_OF_CUSTOM_GATES, the POWER_CUSTOM_GATE_START_TIME and the POWER_CUSTOM_GATE_STOP_TIME attributes. The default value is False.

    Name (Value)

    Description

    False (0)

    Disables power measurement.

    True (1)

    Enables power measurement.

Returns:

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

Return type:

int

configure_power_measurement_number_of_custom_gates(selector_string, number_of_custom_gates)[source]

Configures the number of custom gates for power measurement.

Parameters:

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

  • number_of_custom_gates (int) – This parameter specifies the number of custom gates used for power measurement. The default value is 0.

Returns:

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

Return type:

int

get_acquisition_length(selector_string)[source]

Gets the length of the waveform to be acquired for the DSSSModAcc measurement when you set the ACQUISITION_LENGTH_MODE attribute to Manual. This value is expressed in seconds.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the length of the waveform to be acquired for the DSSSModAcc measurement when you set the ACQUISITION_LENGTH_MODE attribute to Manual. This value is expressed in seconds.

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

Gets whether the measurement automatically computes the acquisition length of the waveform based on DSSSModAcc attributes.

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

Name (Value)

Description

Manual (0)

Uses the acquisition length specified by the DSSSModAcc Acquisition Length attribute.

Auto (1)

Computes the acquisition length based on the DSSSModAcc Meas Offset attribute and the DSSSModAcc Max Meas Length attribute.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DsssModAccAcquisitionLengthMode):

Specifies whether the measurement automatically computes the acquisition length of the waveform based on DSSSModAcc attributes.

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

Gets whether to enable all the traces computed by DSSSModAcc 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 all the traces computed by DSSSModAcc 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 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 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 DSSSModAcc 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)

Performs measurement on a single acquisition.

True (1)

Measurement uses the DSSSModAcc Averaging Count attribute for the number of acquisitions using which the results are averaged.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DsssModAccAveragingEnabled):

Specifies whether to enable averaging for DSSSModAcc 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_burst_start_detection_enabled(selector_string)[source]

Gets whether the measurement detects the rising edge of a burst in the acquired waveform.

The detected rising edge of the burst is used for the measurement. If you are using an I/Q power edge trigger or a digital edge trigger to trigger approximately and consistently at the start of a burst, set this attribute to False. If you are unable to reliably trigger at the start of a burst, set this 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 False.

Name (Value)

Description

False (0)

Disables detection of a rising edge of the burst in the acquired waveform for measurement.

True (1)

Enables detection of a rising edge of the burst in the acquired waveform for measurement.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DsssModAccBurstStartDetectionEnabled):

Specifies whether the measurement detects the rising edge of a burst in the acquired waveform.

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

Gets whether to enable chip clock 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 True.

Name (Value)

Description

False (0)

Disables the chip clock error correction.

True (1)

Enables the chip clock error correction.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DsssModAccChipClockErrorCorrectionEnabled):

Specifies whether to enable chip clock 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_data_decoding_enabled(selector_string)[source]

Gets whether to decode data bits and check for the validity of the cyclic redundancy check (CRC).

Note

Set the MAXIMUM_MEASUREMENT_LENGTH attribute to -1 to decode all chips. Data decoding is not supported if the data rate is 33 Mbps.

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

True (1)

Enables data decoding.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DsssModAccDataDecodingEnabled):

Specifies whether to decode data bits and check for the validity of the cyclic redundancy check (CRC).

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

Gets whether to enable equalization. The IEEE Standard 802.11-2016 does not allow equalization for computing EVM. If you enable equalization, the measurement does not support I/Q impairment estimation.

Equalization is not supported for signals with data rates of 22 Mbps and 33 Mbps. Do not set this attribute to True when performing demodulation measurements on signals with data rates of 22 Mbps and 33 Mbps.

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

True (1)

Enables equalization.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DsssModAccEqualizationEnabled):

Specifies whether to enable equalization. The IEEE Standard 802.11-2016 does not allow equalization for computing EVM. If you enable equalization, the measurement does not support I/Q impairment 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_evm_unit(selector_string)[source]

Gets the unit for 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)

Returns the EVM results as a percentage.

dB (1)

Returns the EVM results in dB.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DsssModAccEvmUnit):

Specifies the unit for 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_frequency_error_correction_enabled(selector_string)[source]

Gets whether to enable frequency 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 True.

Name (Value)

Description

False (0)

Disables frequency error correction.

True (1)

Enables frequency error correction.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DsssModAccFrequencyErrorCorrectionEnabled):

Specifies whether to enable frequency 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_origin_offset_correction_enabled(selector_string)[source]

Gets whether to enable I/Q origin offset 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 True.

Name (Value)

Description

False (0)

Disables the I/Q origin offset correction.

True (1)

Enables the I/Q origin offset correction.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DsssModAccIQOriginOffsetCorrectionEnabled):

Specifies whether to enable I/Q origin offset 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_maximum_measurement_length(selector_string)[source]

Gets the maximum number of data chips that the measurement uses to compute EVM. This value is expressed in chips.

If you set this attribute to -1, all chips in the signal are used for 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 1000.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the maximum number of data chips that the measurement uses to compute EVM. This value is expressed in chips.

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 DSSSModAcc measurement, which is a measurement of the modulation accuracy on signals conforming to the DSSS PHY defined in section 15 and the High Rate DSSS PHY defined in section 16 of IEEE Standard 802.11-2016.

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 DSSSModAcc measurement, which is a measurement of the modulation accuracy on signals conforming to the DSSS PHY defined in section 15 and the High Rate DSSS PHY defined in section 16 of IEEE Standard 802.11-2016.

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 number of data chips to be ignored from the start of the data field for the EVM computation. This value is expressed in chips.

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

Specifies the number of data chips to be ignored from the start of the data field for the EVM computation. This value is expressed in chips.

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

Gets the start time of the custom power gate. This value is expressed in seconds.

Use “gate<k>” as the Selector String to configure or read this attribute.

A value of 0 indicates that the start time is the start of the PPDU. The default value is 0 seconds.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the start time of the custom power gate. This value is expressed in seconds.

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

Gets the stop time for the custom power gate. This value is expressed in seconds.

Use “gate<k>” as the Selector String to configure or read this attribute.

The default value is 10 microseconds.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the stop time for the custom power gate. This value is expressed in seconds.

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

Gets whether power measurement is performed. This measurement computes power of various fields in the PPDU.

Additionally, this measurement computes power over the custom gates that you can configure using the POWER_NUMBER_OF_CUSTOM_GATES, the POWER_CUSTOM_GATE_START_TIME and the POWER_CUSTOM_GATE_STOP_TIME attributes.

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

True (1)

Enables power measurement.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DsssModAccPowerMeasurementEnabled):

Specifies whether power measurement is performed. This measurement computes power of various fields in the PPDU.

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

Gets the number of custom gates used for power 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 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of custom gates used for power 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_pulse_shaping_filter_parameter(selector_string)[source]

Gets the value of the filter roll-off when you set the PULSE_SHAPING_FILTER_TYPE attribute to Raised Cosine or Root Raised Cosine. This attribute is ignored if you set the Pulse Shaping Filter Type attribute to Rectangular.

This attribute is ignored when you set the EQUALIZATION_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 0.5.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the value of the filter roll-off when you set the PULSE_SHAPING_FILTER_TYPE attribute to Raised Cosine or Root Raised Cosine. This attribute is ignored if you set the Pulse Shaping Filter Type attribute to Rectangular.

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

Gets the type of pulse shaping filter used at the transmitter. This attribute is ignored when you set the EQUALIZATION_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 Rectangular.

Name (Value)

Description

Rectangular (0)

Specifies that the transmitter uses a rectangular pulse shaping filter. The measurement uses an impulse response as the matched filter.

Raised Cosine (1)

Specifies that the transmitter uses a raised cosine pulse shaping filter. The measurement uses an impulse response as the matched filter.

Root Raised Cosine (2)

Specifies that the transmitter uses a root raised cosine pulse shaping filter. The measurement uses a root raised cosine filter as the matched filter.

Gaussian (3)

Specifies that the transmitter uses a Gaussian filter. The measurement uses a Gaussian as the matched filter.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DsssModAccPulseShapingFilterType):

Specifies the type of pulse shaping filter used at the transmitter. This attribute is ignored when you set the EQUALIZATION_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_spectrum_inverted(selector_string)[source]

Gets whether the spectrum of the measured signal is inverted.

The inversion occurs when the I and the Q components of the baseband complex signal are swapped.

The default value is False.

Name (Value)

Description

False (0)

The spectrum of the measured signal is not inverted.

True (1)

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

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.DsssModAccSpectrumInverted):

Specifies whether the spectrum of the measured 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_acquisition_length(selector_string, value)[source]

Sets the length of the waveform to be acquired for the DSSSModAcc measurement when you set the ACQUISITION_LENGTH_MODE attribute to Manual. This value is expressed in seconds.

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

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the length of the waveform to be acquired for the DSSSModAcc measurement when you set the ACQUISITION_LENGTH_MODE attribute to Manual. This value is expressed in seconds.

Returns:

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

Return type:

int

set_acquisition_length_mode(selector_string, value)[source]

Sets whether the measurement automatically computes the acquisition length of the waveform based on DSSSModAcc attributes.

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

Name (Value)

Description

Manual (0)

Uses the acquisition length specified by the DSSSModAcc Acquisition Length attribute.

Auto (1)

Computes the acquisition length based on the DSSSModAcc Meas Offset attribute and the DSSSModAcc Max Meas Length attribute.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.DsssModAccAcquisitionLengthMode, int) – Specifies whether the measurement automatically computes the acquisition length of the waveform based on DSSSModAcc attributes.

Returns:

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

Return type:

int

set_all_traces_enabled(selector_string, value)[source]

Sets whether to enable all the traces computed by DSSSModAcc 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 all the traces computed by DSSSModAcc 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 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 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 DSSSModAcc 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)

Performs measurement on a single acquisition.

True (1)

Measurement uses the DSSSModAcc Averaging Count attribute for the number of acquisitions using which the results are averaged.
Parameters:
Returns:

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

Return type:

int

set_burst_start_detection_enabled(selector_string, value)[source]

Sets whether the measurement detects the rising edge of a burst in the acquired waveform.

The detected rising edge of the burst is used for the measurement. If you are using an I/Q power edge trigger or a digital edge trigger to trigger approximately and consistently at the start of a burst, set this attribute to False. If you are unable to reliably trigger at the start of a burst, set this 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 False.

Name (Value)

Description

False (0)

Disables detection of a rising edge of the burst in the acquired waveform for measurement.

True (1)

Enables detection of a rising edge of the burst in the acquired waveform for 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_chip_clock_error_correction_enabled(selector_string, value)[source]

Sets whether to enable chip clock 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 True.

Name (Value)

Description

False (0)

Disables the chip clock error correction.

True (1)

Enables the chip clock error correction.
Parameters:
Returns:

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

Return type:

int

set_data_decoding_enabled(selector_string, value)[source]

Sets whether to decode data bits and check for the validity of the cyclic redundancy check (CRC).

Note

Set the MAXIMUM_MEASUREMENT_LENGTH attribute to -1 to decode all chips. Data decoding is not supported if the data rate is 33 Mbps.

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

True (1)

Enables data decoding.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.DsssModAccDataDecodingEnabled, int) – Specifies whether to decode data bits and check for the validity of the cyclic redundancy check (CRC).

Returns:

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

Return type:

int

set_equalization_enabled(selector_string, value)[source]

Sets whether to enable equalization. The IEEE Standard 802.11-2016 does not allow equalization for computing EVM. If you enable equalization, the measurement does not support I/Q impairment estimation.

Equalization is not supported for signals with data rates of 22 Mbps and 33 Mbps. Do not set this attribute to True when performing demodulation measurements on signals with data rates of 22 Mbps and 33 Mbps.

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

True (1)

Enables equalization.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.DsssModAccEqualizationEnabled, int) – Specifies whether to enable equalization. The IEEE Standard 802.11-2016 does not allow equalization for computing EVM. If you enable equalization, the measurement does not support I/Q impairment estimation.

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 unit for 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)

Returns the EVM results as a percentage.

dB (1)

Returns the EVM results in dB.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.DsssModAccEvmUnit, int) – Specifies the unit for 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_frequency_error_correction_enabled(selector_string, value)[source]

Sets whether to enable frequency 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 True.

Name (Value)

Description

False (0)

Disables frequency error correction.

True (1)

Enables frequency error correction.
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_correction_enabled(selector_string, value)[source]

Sets whether to enable I/Q origin offset 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 True.

Name (Value)

Description

False (0)

Disables the I/Q origin offset correction.

True (1)

Enables the I/Q origin offset correction.
Parameters:
Returns:

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

Return type:

int

set_maximum_measurement_length(selector_string, value)[source]

Sets the maximum number of data chips that the measurement uses to compute EVM. This value is expressed in chips.

If you set this attribute to -1, all chips in the signal are used for 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 1000.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the maximum number of data chips that the measurement uses to compute EVM. This value is expressed in chips.

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 DSSSModAcc measurement, which is a measurement of the modulation accuracy on signals conforming to the DSSS PHY defined in section 15 and the High Rate DSSS PHY defined in section 16 of IEEE Standard 802.11-2016.

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 DSSSModAcc measurement, which is a measurement of the modulation accuracy on signals conforming to the DSSS PHY defined in section 15 and the High Rate DSSS PHY defined in section 16 of IEEE Standard 802.11-2016.

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 number of data chips to be ignored from the start of the data field for the EVM computation. This value is expressed in chips.

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.

  • value (int) – Specifies the number of data chips to be ignored from the start of the data field for the EVM computation. This value is expressed in chips.

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

Returns:

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

Return type:

int

set_power_custom_gate_start_time(selector_string, value)[source]

Sets the start time of the custom power gate. This value is expressed in seconds.

Use “gate<k>” as the Selector String to configure or read this attribute.

A value of 0 indicates that the start time is the start of the PPDU. The default value is 0 seconds.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the start time of the custom power gate. This value is expressed in seconds.

Returns:

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

Return type:

int

set_power_custom_gate_stop_time(selector_string, value)[source]

Sets the stop time for the custom power gate. This value is expressed in seconds.

Use “gate<k>” as the Selector String to configure or read this attribute.

The default value is 10 microseconds.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the stop time for the custom power gate. This value is expressed in seconds.

Returns:

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

Return type:

int

set_power_measurement_enabled(selector_string, value)[source]

Sets whether power measurement is performed. This measurement computes power of various fields in the PPDU.

Additionally, this measurement computes power over the custom gates that you can configure using the POWER_NUMBER_OF_CUSTOM_GATES, the POWER_CUSTOM_GATE_START_TIME and the POWER_CUSTOM_GATE_STOP_TIME attributes.

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

True (1)

Enables power measurement.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.DsssModAccPowerMeasurementEnabled, int) – Specifies whether power measurement is performed. This measurement computes power of various fields in the PPDU.

Returns:

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

Return type:

int

set_power_number_of_custom_gates(selector_string, value)[source]

Sets the number of custom gates used for power 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 0.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the number of custom gates used for power measurement.

Returns:

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

Return type:

int

set_pulse_shaping_filter_parameter(selector_string, value)[source]

Sets the value of the filter roll-off when you set the PULSE_SHAPING_FILTER_TYPE attribute to Raised Cosine or Root Raised Cosine. This attribute is ignored if you set the Pulse Shaping Filter Type attribute to Rectangular.

This attribute is ignored when you set the EQUALIZATION_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 0.5.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the value of the filter roll-off when you set the PULSE_SHAPING_FILTER_TYPE attribute to Raised Cosine or Root Raised Cosine. This attribute is ignored if you set the Pulse Shaping Filter Type attribute to Rectangular.

Returns:

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

Return type:

int

set_pulse_shaping_filter_type(selector_string, value)[source]

Sets the type of pulse shaping filter used at the transmitter. This attribute is ignored when you set the EQUALIZATION_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 Rectangular.

Name (Value)

Description

Rectangular (0)

Specifies that the transmitter uses a rectangular pulse shaping filter. The measurement uses an impulse response as the matched filter.

Raised Cosine (1)

Specifies that the transmitter uses a raised cosine pulse shaping filter. The measurement uses an impulse response as the matched filter.

Root Raised Cosine (2)

Specifies that the transmitter uses a root raised cosine pulse shaping filter. The measurement uses a root raised cosine filter as the matched filter.

Gaussian (3)

Specifies that the transmitter uses a Gaussian filter. The measurement uses a Gaussian as the matched filter.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.DsssModAccPulseShapingFilterType, int) – Specifies the type of pulse shaping filter used at the transmitter. This attribute is ignored when you set the EQUALIZATION_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_spectrum_inverted(selector_string, value)[source]

Sets whether the spectrum of the measured signal is inverted.

The inversion occurs when the I and the Q components of the baseband complex signal are swapped.

The default value is False.

Name (Value)

Description

False (0)

The spectrum of the measured signal is not inverted.

True (1)

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

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

Return type:

int