SemConfiguration

Provides methods to configure the Sem measurement.

class nirfmxwlan.sem_configuration.SemConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the Sem measurement.

configure_averaging(selector_string, averaging_enabled, averaging_count, averaging_type)[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.SemAveragingEnabled, int) –

    This parameter specifies whether to enable averaging for the SEM. 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.

  • averaging_type (enums.SemAveragingType, int) –

    This parameter specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for SEM measurement. The default value is RMS.

    Name (Value)

    Description

    RMS (0)

    The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.

    Log (1)

    The power spectrum is averaged in a logarithmic scale.

    Scalar (2)

    The square root of the power spectrum is averaged.

    Max (3)

    The peak power in the spectrum at each frequency bin is retained from one record to the next.

    Min (4)

    The least power in the spectrum at each frequency bin is retained from one record to the next.

Returns:

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

Return type:

int

configure_mask_type(selector_string, mask_type)[source]

Configures the mask type for the SEM measurement.

Parameters:

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

  • mask_type (enums.SemMaskType, int) –

    This parameter specifies whether the mask used for the SEM measurement is as per the 3GPP standard or specified by you. The default value is Standard.

    Name (Value)

    Description

    Standard (0)

    Mask limits are configured as per the standard.

    Custom (1)

    Mask limits are configured by you.

Returns:

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

Return type:

int

configure_number_of_offsets(selector_string, number_of_offsets)[source]

Configures the number of offset segments for the SEM measurement when you set the MASK_TYPE attribute to Custom.

Parameters:

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

  • number_of_offsets (int) – This parameter specifies the number of SEM offset segments. The default value is 1.

Returns:

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

Return type:

int

configure_offset_frequency_array(selector_string, offset_start_frequency, offset_stop_frequency, offset_sideband)[source]

Configures the array of offset start and stop frequencies and specifies whether the offsets are present on one side, or on both the sides of the carrier when you set the MASK_TYPE attribute to Custom.

Parameters:

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

  • offset_start_frequency (float) – This parameter specifies the array of offset start frequencies, relative to the carrier frequency. This value is expressed in Hz. The default value is an empty array.

  • offset_stop_frequency (float) – This parameter specifies the array of offset stop frequencies, relative to the carrier frequency. This value is expressed in Hz. The default value is an empty array.

  • offset_sideband (enums.SemOffsetSideband, int) –

    This parameter specifies whether the offset segments present on one or both sides of the carrier. The default value is Both.

    Name (Value)

    Description

    Neg (0)

    Configures a lower offset segment to the left of the carrier.

    Pos (1)

    Configures an upper offset segment to the right of the carrier.

    Both (2)

    Configures both negative and positive offset segments.

Returns:

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

Return type:

int

configure_offset_relative_limit_array(selector_string, relative_limit_start, relative_limit_stop)[source]

Configures an array of relative mask limits corresponding the start and stop frequencies of the offsets when you set the MASK_TYPE attribute to Custom. The relative limits are relative to the peak power of the carrier.

Parameters:

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

  • relative_limit_start (float) – This parameter specifies the array of relative power limits corresponding to the start frequencies of the offsets. The relative limits are relative to the peak power of the carrier. This value is expressed in dB. The default value is an empty array.

  • relative_limit_stop (float) – This parameter specifies the array of relative power limits corresponding to the stop frequencies of the offsets. The relative limits are relative to the peak power of the carrier. This value is expressed in dB. 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_span(selector_string, span_auto, span)[source]

Configures the frequency range around the center frequency to be acquired for the SEM measurement.

Parameters:

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

  • span_auto (enums.SemSpanAuto, int) –

    This parameter specifies whether the frequency range of the spectrum used for the SEM measurement is computed automatically by the measurement or is configured by you. This parameter is applicable when you set the MASK_TYPE attribute to Standard. The default value is True.

    Name (Value)

    Description

    False (0)

    The span you configure is used as the frequency range for the SEM measurement.

    True (1)

    The span is automatically computed based on the configured standard and bandwidth.

  • span (float) – This parameter specifies the frequency range of the spectrum that is used for the SEM measurement. This value is expressed in Hz. This parameter is applicable only when you set the Span Auto parameter to False, and the MASK_TYPE attribute to Standard. The default value is 66 MHz.

Returns:

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

Return type:

int

configure_sweep_time(selector_string, sweep_time_auto, sweep_time_interval)[source]

Configures the sweep time.

Parameters:

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

  • sweep_time_auto (enums.SemSweepTimeAuto, int) –

    This parameter specifies whether the sweep time for the SEM measurement is computed automatically by the measurement or is configured by you. The default value is True.

    Name (Value)

    Description

    False (0)

    The sweep time you configure using the Sweep Time parameter is used as the sweep time for the SEM measurement.

    True (1)

    The sweep time is computed automatically based on the configured standard.

  • sweep_time_interval (float) – This parameter specifies the sweep time for the SEM measurement. This value is expressed in seconds. This parameter is ignored when you set the SEM Sweep Time Auto parameter to False. The default value is 1 ms.

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

Gets whether the amplitude of the frequency bins, used in the measurement, is corrected for external attenuation at the RF center frequency, or at the individual frequency bins. Use the nirfmxinstr.session.Session.configure_external_attenuation_table() method to configure the external attenuation table.

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 RF Center Frequency.

Name (Value)

Description

RF Center Frequency (0)

All the frequency bins in the spectrum are compensated with a single external attenuation value that corresponds to the RF center frequency.

Spectrum Frequency Bin (1)

An individual frequency bin in the spectrum is compensated with the external attenuation value corresponding to that frequency.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemAmplitudeCorrectionType):

Specifies whether the amplitude of the frequency bins, used in the measurement, is corrected for external attenuation at the RF center frequency, or at the individual frequency bins. Use the nirfmxinstr.session.Session.configure_external_attenuation_table() method to configure the external attenuation table.

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 the SEM 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 SEM measurement uses the SEM Averaging Count attribute as the number of acquisitions over which the SEM measurement is averaged.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemAveragingEnabled):

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

Gets the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for SEM 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 RMS.

Name (Value)

Description

RMS (0)

The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.

Log (1)

The power spectrum is averaged in a logarithmic scale.

Scalar (2)

The square root of the power spectrum is averaged.

Max (3)

The peak power in the spectrum is retained from one acquisition to the next at each frequency bin.

Min (4)

The least power in the spectrum is retained from one acquisition to the next at each frequency bin.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemAveragingType):

Specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for SEM 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_carrier_integration_bandwidth(selector_string)[source]

Gets the integration bandwidth of the carrier as per the standard and channel bandwidth. This value is expressed in Hz.

You do not need to use a selector string to 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 18 M.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Returns the integration bandwidth of the carrier as per the standard and channel bandwidth. This value is expressed in Hz.

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

Gets whether the mask used for the SEM measurement is defined either as per the standard or as specified by you.

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

Name (Value)

Description

Standard (0)

Mask limits are configured as per the specified standard, channel bandwidth, and band.

Custom (1)

The measurement uses the mask limits that you specify.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemMaskType):

Specifies whether the mask used for the SEM measurement is defined either as per the standard or as specified by you.

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 spectral emission mask (SEM) 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 spectral emission mask (SEM) 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 SEM 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 SEM 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_offsets(selector_string)[source]

Gets the number of offset segments for the SEM measurement when you set the MASK_TYPE attribute to Custom.

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

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the number of offset segments for the SEM measurement when you set the MASK_TYPE attribute to Custom.

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

Gets the relative power limit corresponding to the start of the offset segment. This value is expressed in dB.

Use “offset<n>” as the Selector String to configure this attribute.

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the relative power limit corresponding to the start of the offset segment. This value is expressed 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)

get_offset_relative_limit_stop(selector_string)[source]

Gets the relative power limit corresponding to the end of the offset segment. This value is expressed in dB.

Use “offset<n>” as the Selector String to configure this attribute.

The default value is -20.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the relative power limit corresponding to the end of the offset segment. This value is expressed 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)

get_offset_sideband(selector_string)[source]

Gets whether the offset segment is present on one side or on both sides of the carrier.

Use “offset<n>” as the Selector String to configure this attribute.

The default value is Both.

Name (Value)

Description

Neg (0)

Configures a lower offset segment to the left of the carrier.

Pos (1)

Configures an upper offset segment to the right of the carrier.

Both (2)

Configures both negative and positive offset segments.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemOffsetSideband):

Specifies whether the offset segment is present on one side or on both sides of the carrier.

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

Gets the start frequency of the offset segment relative to the carrier frequency. This value is expressed in Hz.

Use “offset<n>” as the Selector String to configure this attribute.

The default value is 9 MHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the start frequency of the offset segment relative to the carrier frequency. This value is expressed in Hz.

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

Gets the stop frequency of the offset segment relative to carrier frequency. This value is expressed in Hz.

Use “offset<n>” as the Selector String to configure this attribute.

The default value is 11 MHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the stop frequency of the offset segment relative to carrier frequency. This value is expressed in Hz.

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

Gets the frequency range of the spectrum used for the SEM measurement. This value is expressed in Hz.

This attribute is applicable only when you set the SPAN_AUTO attribute to False and the MASK_TYPE attribute to Standard.

You do not need to use a selector string to 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 66 MHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the frequency range of the spectrum used for the SEM measurement. This value is expressed in Hz.

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

Gets whether the frequency range of the spectrum used for SEM measurement is computed automatically by the measurement or is configured by you.

This attribute is applicable when you set the MASK_TYPE attribute to Standard.

You do not need to use a selector string to 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 span you configure is used as the frequency range for the SEM measurement.

True (1)

The span is automatically computed based on the configured standard and channel bandwidth.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemSpanAuto):

Specifies whether the frequency range of the spectrum used for SEM measurement is computed automatically by the measurement or is configured by you.

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

Gets whether the sweep time for the SEM measurement is computed automatically or is configured by you.

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 measurement uses the sweep time that you specify in the SEM Sweep Time attribute.

True (1)

The measurement automatically calculates the sweep time based on the standard and bandwidth you specify.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemSweepTimeAuto):

Specifies whether the sweep time for the SEM measurement is computed automatically or is configured by you.

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

Gets the sweep time for the SEM measurement. This value is expressed in seconds.

This attribute is ignored when you set the SWEEP_TIME_AUTO 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 1 millisecond.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the sweep time for the SEM measurement. 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)

set_all_traces_enabled(selector_string, value)[source]

Sets whether to enable the traces to be stored and retrieved after performing the SEM 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 SEM measurement.

Returns:

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

Return type:

int

set_amplitude_correction_type(selector_string, value)[source]

Sets whether the amplitude of the frequency bins, used in the measurement, is corrected for external attenuation at the RF center frequency, or at the individual frequency bins. Use the nirfmxinstr.session.Session.configure_external_attenuation_table() method to configure the external attenuation table.

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 RF Center Frequency.

Name (Value)

Description

RF Center Frequency (0)

All the frequency bins in the spectrum are compensated with a single external attenuation value that corresponds to the RF center frequency.

Spectrum Frequency Bin (1)

An individual frequency bin in the spectrum is compensated with the external attenuation value corresponding to that frequency.
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 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 the SEM 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 SEM measurement uses the SEM Averaging Count attribute as the number of acquisitions over which the SEM measurement is averaged.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.SemAveragingEnabled, int) – Specifies whether to enable averaging for the SEM 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_type(selector_string, value)[source]

Sets the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for SEM 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 RMS.

Name (Value)

Description

RMS (0)

The power spectrum is linearly averaged. RMS averaging reduces signal fluctuations but not the noise floor.

Log (1)

The power spectrum is averaged in a logarithmic scale.

Scalar (2)

The square root of the power spectrum is averaged.

Max (3)

The peak power in the spectrum is retained from one acquisition to the next at each frequency bin.

Min (4)

The least power in the spectrum is retained from one acquisition to the next at each frequency bin.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.SemAveragingType, int) – Specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for SEM measurement.

Returns:

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

Return type:

int

set_mask_type(selector_string, value)[source]

Sets whether the mask used for the SEM measurement is defined either as per the standard or as specified by you.

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

Name (Value)

Description

Standard (0)

Mask limits are configured as per the specified standard, channel bandwidth, and band.

Custom (1)

The measurement uses the mask limits that you specify.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.SemMaskType, int) – Specifies whether the mask used for the SEM measurement is defined either as per the standard or as specified by you.

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 spectral emission mask (SEM) 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 spectral emission mask (SEM) 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 SEM 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 SEM 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_offsets(selector_string, value)[source]

Sets the number of offset segments for the SEM measurement when you set the MASK_TYPE attribute to Custom.

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

The default value is 1.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (int) – Specifies the number of offset segments for the SEM measurement when you set the MASK_TYPE attribute to Custom.

Returns:

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

Return type:

int

set_offset_relative_limit_start(selector_string, value)[source]

Sets the relative power limit corresponding to the start of the offset segment. This value is expressed in dB.

Use “offset<n>” as the Selector String to configure this attribute.

The default value is 0.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the relative power limit corresponding to the start of the offset segment. This value is expressed in dB.

Returns:

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

Return type:

int

set_offset_relative_limit_stop(selector_string, value)[source]

Sets the relative power limit corresponding to the end of the offset segment. This value is expressed in dB.

Use “offset<n>” as the Selector String to configure this attribute.

The default value is -20.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the relative power limit corresponding to the end of the offset segment. This value is expressed in dB.

Returns:

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

Return type:

int

set_offset_sideband(selector_string, value)[source]

Sets whether the offset segment is present on one side or on both sides of the carrier.

Use “offset<n>” as the Selector String to configure this attribute.

The default value is Both.

Name (Value)

Description

Neg (0)

Configures a lower offset segment to the left of the carrier.

Pos (1)

Configures an upper offset segment to the right of the carrier.

Both (2)

Configures both negative and positive offset segments.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.SemOffsetSideband, int) – Specifies whether the offset segment is present on one side or on both sides of the carrier.

Returns:

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

Return type:

int

set_offset_start_frequency(selector_string, value)[source]

Sets the start frequency of the offset segment relative to the carrier frequency. This value is expressed in Hz.

Use “offset<n>” as the Selector String to configure this attribute.

The default value is 9 MHz.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the start frequency of the offset segment relative to the carrier frequency. This value is expressed in Hz.

Returns:

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

Return type:

int

set_offset_stop_frequency(selector_string, value)[source]

Sets the stop frequency of the offset segment relative to carrier frequency. This value is expressed in Hz.

Use “offset<n>” as the Selector String to configure this attribute.

The default value is 11 MHz.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the stop frequency of the offset segment relative to carrier frequency. This value is expressed in Hz.

Returns:

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

Return type:

int

set_span(selector_string, value)[source]

Sets the frequency range of the spectrum used for the SEM measurement. This value is expressed in Hz.

This attribute is applicable only when you set the SPAN_AUTO attribute to False and the MASK_TYPE attribute to Standard.

You do not need to use a selector string to 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 66 MHz.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the frequency range of the spectrum used for the SEM measurement. This value is expressed in Hz.

Returns:

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

Return type:

int

set_span_auto(selector_string, value)[source]

Sets whether the frequency range of the spectrum used for SEM measurement is computed automatically by the measurement or is configured by you.

This attribute is applicable when you set the MASK_TYPE attribute to Standard.

You do not need to use a selector string to 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 span you configure is used as the frequency range for the SEM measurement.

True (1)

The span is automatically computed based on the configured standard and channel bandwidth.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.SemSpanAuto, int) – Specifies whether the frequency range of the spectrum used for SEM measurement is computed automatically by the measurement or is configured by you.

Returns:

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

Return type:

int

set_sweep_time_auto(selector_string, value)[source]

Sets whether the sweep time for the SEM measurement is computed automatically or is configured by you.

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 measurement uses the sweep time that you specify in the SEM Sweep Time attribute.

True (1)

The measurement automatically calculates the sweep time based on the standard and bandwidth you specify.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.SemSweepTimeAuto, int) – Specifies whether the sweep time for the SEM measurement is computed automatically or is configured by you.

Returns:

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

Return type:

int

set_sweep_time_interval(selector_string, value)[source]

Sets the sweep time for the SEM measurement. This value is expressed in seconds.

This attribute is ignored when you set the SWEEP_TIME_AUTO 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 1 millisecond.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the sweep time for the SEM measurement. 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