SemConfiguration

Provides methods to configure the Sem measurement.

class nirfmxspecan.sem_configuration.SemConfiguration(signal_obj)

Bases: object

Provides methods to configure the Sem measurement.

configure_averaging(selector_string, averaging_enabled, averaging_count, averaging_type)

Configures averaging for the spectral emission mask (SEM) 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 measurement. The default value is False.

  Name (Value)	Description
  False (0)	The measurement is performed on a single acquisition.
  True (1)	The measurement uses the value of the Averaging Count parameter to calculate the number of acquisitions over which the 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.

• averaging_type (enums.SemAveragingType, int) –

  This parameter specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for the measurement. Refer to the Averaging section of the Spectral Measurements Concepts topic for more information about averaging types. 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 acquisition to the next.
  Min (4)	The least power in the spectrum at each frequency bin is retained from one acquisition 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_carrier_channel_bandwidth(selector_string, carrier_channel_bandwidth)

Configures the channel bandwidth of the carrier.

Use “carrier< * n * >” as the selector string to configure this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of carrier number.

  Example:

  ”carrier0”

  You can use the build_carrier_string() method to build the selector string.

• carrier_channel_bandwidth (float) – This parameter specifies the channel bandwidth of the carrier. This parameter is used to calculate the values of the OFFSET_START_FREQUENCY and OFFSET_STOP_FREQUENCY attributes when you set the OFFSET_FREQUENCY_DEFINITION attribute to Carrier Edge to Meas BW Center or Carrier Edge to Meas BW Edge. The default value is 2 MHz.

Returns:

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

Return type:

int

configure_carrier_enabled(selector_string, carrier_enabled)

Configures whether to consider the carrier power as part of total carrier power measurement. Use “carrier<n>” as the selector string to configure this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of carrier number.

  Example:

  ”carrier0”

  You can use the build_carrier_string() method to build the selector string.

• carrier_enabled (enums.SemCarrierEnabled, int) –

  This parameter specifies whether to consider the carrier power as part of total carrier power measurement. The default value is True.

  Name (Value)	Description
  False (0)	The carrier power is not considered as part of the total carrier power.
  True (1)	The carrier power is considered as part of the total carrier power.

Returns:

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

Return type:

int

configure_carrier_frequency(selector_string, carrier_frequency)

Configures the center frequency, in Hz, of the carrier, relative to the RF center frequency.

Use “carrier< * n * >” as the selector string to configure this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of carrier number.

  Example:

  ”carrier0”

  You can use the build_carrier_string() method to build the selector string.

• carrier_frequency (float) – This parameter specifies the center frequency, in Hz, of the carrier, relative to the RF CENTER_FREQUENCY. 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

configure_carrier_integration_bandwidth(selector_string, integration_bandwidth)

Configures the frequency range, in Hz, over which the measurement integrates the carrier power. Use “carrier<n>” as the selector string to configure this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of carrier number.

  Example:

  ”carrier0”

  You can use the build_carrier_string() method to build the selector string.

• integration_bandwidth (float) – This parameter specifies the frequency range, in Hz, over which the measurement integrates the carrier channel power. The default value is 2 MHz.

Returns:

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

Return type:

int

configure_carrier_rbw_filter(selector_string, rbw_auto, rbw, rbw_filter_type)

Configures the resolution bandwidth (RBW) filter of the carrier signal. Use “carrier<n>” as the selector string to configure this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of carrier number.

  Example:

  ”carrier0”

  You can use the build_carrier_string() method to build the selector string.

• rbw_auto (enums.SemCarrierRbwAutoBandwidth, int) –

  This parameter specifies whether the measurement computes the resolution bandwidth (RBW) of the carrier. Refer to the SEM topic for more details on RBW. The default value is True.

  Name (Value)	Description
  False (0)	The measurement uses the RBW that you specify in the RBW parameter.
  True (1)	The measurement computes the RBW.

• rbw (float) – This parameter specifies the bandwidth, in Hz, of the resolution bandwidth (RBW) filter used to sweep the acquired carrier signal, when you set the RBW Auto parameter to False. The default value is 10 kHz.

• rbw_filter_type (enums.SemCarrierRbwFilterType, int) –

  This parameter specifies the response of the digital RBW filter. The default value is Gaussian.

  Name (Value)	Description
  FFT Based (0)	No RBW filtering is performed.
  Gaussian (1)	An RBW filter with a Gaussian response is applied.
  Flat (2)	An RBW filter with a flat response is applied.

Returns:

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

Return type:

int

configure_carrier_rrc_filter(selector_string, rrc_filter_enabled, rrc_alpha)

Configures the root raised cosine (RRC) channel filter to apply on the acquired carrier channel before measuring the channel power. RRC alpha is the filter roll off. Use “carrier<n>” as the selector string to configure this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of carrier number.

  Example:

  ”carrier0”

  You can use the build_carrier_string() method to build the selector string.

• rrc_filter_enabled (enums.SemCarrierRrcFilterEnabled, int) –

  This parameter specifies whether to apply the root-raised-cosine (RRC) filter on the acquired carrier channel before measuring the carrier channel power. The default value is False.

  Name (Value)	Description
  False (0)	The channel power of the acquired carrier channel is measured directly.
  True (1)	The RRC filter on the acquired carrier channel is applied before measuring the carrier channel power.

• rrc_alpha (float) – This parameter specifies the roll-off factor for the root-raised-cosine (RRC) filter. The default value is 0.1.

Returns:

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

Return type:

int

configure_fft(selector_string, fft_window, fft_padding)

Configures window and FFT to obtain a spectrum for the spectral emission mask (SEM) measurement.

Parameters:

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

• fft_window (enums.SemFftWindow, int) –

  This parameter specifies the FFT window type to use to reduce spectral leakage. Refer to the Window and FFT section of the Spectral Measurements Concepts topic for more information about FFT window types. The default value is Flat Top.

  Name (Value)	Description
  None (0)	Analyzes transients for which duration is shorter than the window length. You can also use this window type to separate two tones with frequencies close to each other but with almost equal amplitudes.
  Flat Top (1)	Measures single-tone amplitudes accurately.
  Hanning (2)	Analyzes transients for which duration is longer than the window length. You can also use this window type to provide better frequency resolution for noise measurements.
  Hamming (3)	Analyzes closely-spaced sine waves.
  Gaussian (4)	Provides a balance of spectral leakage, frequency resolution, and amplitude attenuation. This windowing is useful for time-frequency analysis.
  Blackman (5)	Analyzes single tone because it has a low maximum side lobe level and a high side lobe roll-off rate.
  Blackman-Harris (6)	Useful as a general purpose window, having side lobe rejection greater than 90 dB and having a moderately wide main lobe.
  Kaiser-Bessel (7)	Separates two tones with frequencies close to each other but with widely-differing amplitudes.

• fft_padding (float) – This parameter specifies the factor by which the time-domain waveform is zero-padded before an FFT. The FFT size is given by the following formula: FFT size = waveform size * padding. This parameter is used only when the acquisition span is less than the device instantaneous bandwidth. 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_number_of_carriers(selector_string, number_of_carriers)

Configures the number of carriers for the spectral emission mask (SEM) measurement.

Parameters:

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

• number_of_carriers (int) – This parameter specifies the number of carriers. 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_number_of_offsets(selector_string, number_of_offsets)

Configures the number of offset segments for the spectral emission mask (SEM) measurement.

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 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_absolute_limit(selector_string, absolute_limit_mode, absolute_limit_start, absolute_limit_stop)

Configures the absolute limit mode and specifies the absolute power limits corresponding to the beginning and end of the offset segment. Use “offset<n>” as the selector string to configure this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of offset number.

  Example:

  ”offset0”

  You can use the build_offset_string() method to build the selector string.

• absolute_limit_mode (enums.SemOffsetAbsoluteLimitMode, int) –

  This parameter specifies whether the absolute limit mask is a flat line or a line with a slope. The default value is Couple.

  Name (Value)	Description
  Manual (0)	The line specified by the SEM Offset Abs Limit Start and SEM Offset Abs Limit Stop attribute values as the two ends is considered as the mask.
  Couple (1)	The two ends of the line are coupled to the value of the SEM Offset Abs Limit Start attribute.

• absolute_limit_start (float) – This parameter specifies the absolute power limit, in dBm, corresponding to the beginning of the offset segment. The value of this parameter is also set as the stop limit for the offset segment when you set the Absolute Limit Mode parameter to Couple. The default value is -10.

• absolute_limit_stop (float) – This parameter specifies the absolute power limit, in dBm, corresponding to the end of the offset segment. This parameter is ignored when you set the Absolute Limit Mode parameter to Couple. 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_offset_absolute_limit_array(selector_string, absolute_limit_mode, absolute_limit_start, absolute_limit_stop)

Configures the absolute limit mode and specifies the absolute power limits corresponding to the beginning and end of the offset segment.

Parameters:

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

• absolute_limit_mode (enums.SemOffsetAbsoluteLimitMode, int) –

  This parameter specifies whether the absolute limit mask is a flat line or a line with a slope. The default value is Couple.

  Name (Value)	Description
  Manual (0)	The line specified by the SEM Offset Abs Limit Start and SEM Offset Abs Limit Stop attribute values as the two ends is considered as the mask.
  Couple (1)	The two ends of the line are coupled to the value of the SEM Offset Abs Limit Start attribute.

• absolute_limit_start (float) – This parameter specifies the array of absolute power limits, in dBm, corresponding to the beginning of the offset segment. The value of this parameter is also set as the stop limit for the offset segment when you set the Absolute Limit Mode parameter to Couple. The default value is -10.

• absolute_limit_stop (float) – This parameter specifies the array of absolute power limits, in dBm, corresponding to the end of the offset segment. This parameter is ignored when you set the Absolute Limit Mode parameter to Couple. 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_offset_bandwidth_integral(selector_string, bandwidth_integral)

Configures the resolution of the spectrum to compare with spectral mask limits as an integer multiple of the resolution bandwidth (RBW). Use “offset<n>” as the selector string to configure this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of offset number.

  Example:

  ”offset0”

  You can use the build_offset_string() method to build the selector string.

• bandwidth_integral (int) – This parameter specifies the resolution of the spectrum to compare with spectral mask limits as an integer multiple of the RBW. If you set this parameter to a value greater than 1, the measurement acquires the spectrum with a narrow resolution and then processes it digitally to get a wider resolution that is equal to the product of the bandwidth integral and the RBW. 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(selector_string, offset_start_frequency, offset_stop_frequency, offset_enabled, offset_sideband)

Configures the offset frequency start and stop values and specifies whether the offset segment is present on one side, or on both sides of the carriers. Use “offset<n>” as the selector string to configure this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of offset number.

  Example:

  ”offset0”

  You can use the build_offset_string() method to build the selector string.

• offset_start_frequency (float) – This parameter specifies the start frequency, in Hz, of the offset segment relative to the closest configured carrier channel bandwidth center or carrier channel bandwidth edge based on the value of the OFFSET_FREQUENCY_DEFINITION attribute. The default value is 1 MHz.

• offset_stop_frequency (float) – This parameter specifies the stop frequency, in Hz, of the offset segment relative to the closest configured carrier channel bandwidth center or carrier channel bandwidth edge based on the value of the SEM Offset Freq Definition attribute. The default value is 2 MHz.

• offset_enabled (enums.SemOffsetEnabled, int) –

  This parameter specifies whether to enable the offset segment for the SEM measurement. The default value is True.

  Name (Value)	Description
  False (0)	Disables the offset segment for the SEM measurement.
  True (1)	Enables the offset segment for the SEM measurement.

• offset_sideband (enums.SemOffsetSideband, int) –

  This parameter specifies whether the offset segment is present on one side, or on both sides of the carriers. The default value is Both.

  Name (Value)	Description
  Neg (0)	Configures a lower offset segment to the left of the leftmost carrier.
  Pos (1)	Configures an upper offset segment to the right of the rightmost 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_frequency_array(selector_string, offset_start_frequency, offset_stop_frequency, offset_enabled, offset_sideband)

Configures the offset frequency start and stop values and specifies whether the offset segment is present on one side, or on both sides of the carriers.

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 start frequencies, in Hz, of each offset segment relative to the closest configured carrier channel bandwidth center or carrier channel bandwidth edge based on the value of the OFFSET_FREQUENCY_DEFINITION attribute. The default value is 1 MHz.

• offset_stop_frequency (float) – This parameter specifies the array of stop frequencies, in Hz, of each offset segment relative to the closest configured carrier channel bandwidth center or carrier channel bandwidth edge based on the value of the SEM Offset Freq Definition attribute. The default value is 2 MHz.

• offset_enabled (enums.SemOffsetEnabled, int) –

  This parameter specifies whether to enable the offset segment for the SEM measurement. The default value is True.

  Name (Value)	Description
  False (0)	Disables the offset segment for the SEM measurement.
  True (1)	Enables the offset segment for the SEM measurement.

• offset_sideband (enums.SemOffsetSideband, int) –

  This parameter specifies whether the offset segment is present on one side, or on both sides of the carriers. The default value is Both.

  Name (Value)	Description
  Neg (0)	Configures a lower offset segment to the left of the leftmost carrier.
  Pos (1)	Configures an upper offset segment to the right of the rightmost 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_frequency_definition(selector_string, offset_frequency_definition)

Configures the offset frequency definition for the SEM measurement. Use “offset<n>” as the selector string to configure this method.

Parameters:

• selector_string (string) –

  This parameter specifies the Selector String comprising of offset number.

  Example:

  ”offset0”

  You can use the build_offset_string() method to build the selector string.

• offset_frequency_definition (enums.SemOffsetFrequencyDefinition, int) –

  This parameter specifies the definition of the start frequency and stop frequency of the offset segments from the nearest carrier channels. The default value is Carrier Center to Meas BW Center.

  Name (Value)	Description
  Carrier Center to Meas BW Center (0)	The start frequency and stop frequency are defined from the center of the closest carrier channel bandwidth to the center of the offset segment measurement bandwidth. Measurement Bandwidth = Resolution Bandwidth * Bandwidth Integral.
  Carrier Center to Meas BW Edge (1)	The start frequency and stop frequency are defined from the center of the closest carrier channel bandwidth to the nearest edge of the offset segment measurement bandwidth.
  Carrier Edge to Meas BW Center (2)	The start frequency and stop frequency are defined from the nearest edge of the closest carrier channel bandwidth to the center of the nearest offset segment measurement bandwidth.
  Carrier Edge to Meas BW Edge (3)	The start frequency and stop frequency are defined from the nearest edge of the closest carrier channel bandwidth to the edge of the nearest offset segment measurement bandwidth.

Returns:

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

Return type:

int

configure_offset_limit_fail_mask(selector_string, limit_fail_mask)

Specifies the criteria to determine the measurement fail status. Use “offset<n>” as the selector string to configure this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of offset number.

  Example:

  ”offset0”

  You can use the build_offset_string() method to build the selector string.

• limit_fail_mask (enums.SemOffsetLimitFailMask, int) –

  This parameter specifies the criteria to determine the measurement fail status. The default value is Absolute.

  Name (Value)	Description
  Abs AND Rel (0)	The measurement fails if the power in the segment exceeds both the absolute and relative masks.
  Abs OR Rel (1)	The measurement fails if the power in the segment exceeds either the absolute or relative mask.
  Absolute (2)	The measurement fails if the power in the segment exceeds the absolute mask.
  Relative (3)	The measurement fails if the power in the segment exceeds the relative mask.

Returns:

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

Return type:

int

configure_offset_rbw_filter(selector_string, rbw_auto, rbw, rbw_filter_type)

Configures the resolution bandwidth (RBW) filter of the offset segment. Use “offset<n>” as the selector string to configure this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of offset number.

  Example:

  ”offset0”

  You can use the build_offset_string() method to build the selector string.

• rbw_auto (enums.SemOffsetRbwAutoBandwidth, int) –

  This parameter specifies whether the measurement computes the RBW. Refer to the RBW and Sweep Time section in the SEM topic for more details on RBW and sweep time. The default value is True.

  Name (Value)	Description
  False (0)	The measurement uses the RBW that you specify in the RBW parameter.
  True (1)	The measurement computes the RBW.

• rbw (float) – This parameter specifies the bandwidth, in Hz, of the resolution bandwidth (RBW) filter used to sweep the acquired offset segment, when you set the RBW Auto parameter to False. The default value is 10 kHz.

• rbw_filter_type (enums.SemOffsetRbwFilterType, int) –

  This parameter specifies the response of the digital RBW filter. The default value is Gaussian.

  Name (Value)	Description
  FFT Based (0)	No RBW filtering is performed.
  Gaussian (1)	An RBW filter with a Gaussian response is applied.
  Flat (2)	An RBW filter with a flat response is applied.

Returns:

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

Return type:

int

configure_offset_rbw_filter_array(selector_string, rbw_auto, rbw, rbw_filter_type)

Configures the resolution bandwidth (RBW) filter of the offset segment.

Parameters:

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

• rbw_auto (enums.SemOffsetRbwAutoBandwidth, int) –

  This parameter specifies whether the measurement computes the RBW. Refer to the SEM topic for details on RBW and sweep time. The default value is True.

  Name (Value)	Description
  False (0)	The measurement uses the RBW that you specify in the RBW parameter.
  True (1)	The measurement computes the RBW.

• rbw (float) – This parameter specifies the array of bandwidths, in Hz, of the resolution bandwidth (RBW) filter used to sweep the acquired offset segment, when you set the RBW Auto parameter to False. The default value is 10 kHz.

• rbw_filter_type (enums.SemOffsetRbwFilterType, int) –

  This parameter specifies the shape of the digital RBW filter. The default value is Gaussian.

  Name (Value)	Description
  FFT Based (0)	No RBW filtering is performed.
  Gaussian (1)	An RBW filter with a Gaussian response is applied.
  Flat (2)	An RBW filter with a flat response is applied.

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_attenuation(selector_string, relative_attenuation)

Configures the attenuation, in dB, relative to the external attenuation. Use “offset<n>” as the selector string to configure this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of offset number.

  Example:

  ”offset0”

  You can use the build_offset_string() method to build the selector string.

• relative_attenuation (float) – This parameter specifies the attenuation, in dB, relative to the external attenuation. Use this parameter to compensate for variations in external attenuation when the offset channels are spread wide in frequency. 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

configure_offset_relative_attenuation_array(selector_string, relative_attenuation)

Configures the attenuation, in dB, relative to the external attenuation.

Parameters:

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

• relative_attenuation (float) – This parameter specifies an array of attenuation values, in dB, relative to the external attenuation. Use this parameter to compensate for the variations in external attenuation when offset channels are spread wide in frequency. 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

configure_offset_relative_limit(selector_string, relative_limit_mode, relative_limit_start, relative_limit_stop)

Configures the relative limit mode and specifies the relative power limits corresponding to the beginning and end of the offset segment. Use “offset<n>” as the selector string to configure this method.

Parameters:

• selector_string (string) –

  This parameter specifies a Selector String comprising of offset number.

  Example:

  ”offset0”

  You can use the build_offset_string() method to build the selector string.

• relative_limit_mode (enums.SemOffsetRelativeLimitMode, int) –

  This parameter specifies whether the relative limit mask is a flat line or a line with a slope. The default value is Manual.

  Name (Value)	Description
  Manual (0)	The line specified by the SEM Offset Rel Limit Start and SEM Offset Rel Limit Stop attribute values as the two ends is considered as the mask.
  Couple (1)	The two ends of the line are coupled to the value of the SEM Offset Rel Limit Start attribute.

• relative_limit_start (float) – This parameter specifies the relative power limit, in dB, corresponding to the beginning of the offset segment. The value of this parameter is also set as the stop limit for the offset segment when you set the Relative Limit Mode parameter to Couple. The default value is -20.

• relative_limit_stop (float) – This parameter specifies the relative power limit, in dB, corresponding to the end of the offset segment. This parameter is ignored if you set the Relative Limit Mode parameter to Couple. The default value is -30.

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_mode, relative_limit_start, relative_limit_stop)

Configures the relative limit mode and specifies the relative power limits corresponding to the beginning and end of the offset segment.

Parameters:

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

• relative_limit_mode (enums.SemOffsetRelativeLimitMode, int) –

  This parameter specifies whether the relative limit mask is a flat line or a line with a slope. The default value is Manual.

  Name (Value)	Description
  Manual (0)	The line specified by the SEM Offset Rel Limit Start and SEM Offset Rel Limit Stop attribute values as the two ends is considered as the mask.
  Couple (1)	The two ends of the line are coupled to the value of the SEM Offset Rel Limit Start attribute.

• relative_limit_start (float) – This parameter specifies the array of relative power limits, in dB, corresponding to the beginning of the offset segment. The value of this parameter is also set as the stop limit for the offset segment when you set the Relative Limit Mode parameter to Couple. The default value is -20.

• relative_limit_stop (float) – This parameter specifies the array of relative power limits, in dB, corresponding to the end of the offset segment. This parameter is ignored if you set the Relative Limit Mode parameter to Couple. The default value is -30.

Returns:

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

Return type:

int

configure_power_units(selector_string, power_units)

Configures the units for the absolute power.

Parameters:

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

• power_units (enums.SemPowerUnits, int) –

  This parameter specifies the units for the absolute power. The default value is dBm.

  Name (Value)	Description
  dBm (0)	The absolute powers are reported in dBm.
  dBm/Hz (1)	The absolute powers are reported in dBm/Hz.

Returns:

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

Return type:

int

configure_reference_type(selector_string, reference_type)

Configures whether the power reference is the integrated power or the peak power in the closest carrier channel.

Parameters:

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

• reference_type (enums.SemReferenceType, int) –

  This parameter specifies whether the power reference is the integrated power or the peak power in the closest carrier channel. The leftmost carrier is the carrier closest to all the lower (negative) offset segments. The rightmost carrier offset is the carrier closest to all the upper (positive) offset segments. The default value is Integration.

  Name (Value)	Description
  Integration (0)	The power reference is the integrated power of the closest carrier.
  Peak (1)	The power reference is the peak power of the closest carrier.

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)

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 measurement computes the sweep time. The default value is True.

  Name (Value)	Description
  False (0)	The measurement uses the sweep time that you specify in the Sweep Time Interval parameter.
  True (1)	The measurement calculates the sweep time based on the value of the SEM Offset RBW and SEM Carrier RBW attribute.

• sweep_time_interval (float) – This parameter specifies the sweep time, in seconds, when you set the 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)

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)

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)

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)

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)

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 at each frequency bin is retained from one acquisition to the next.
Min (4)	The least power in the spectrum at each frequency bin is retained from one acquisition to the next.

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_channel_bandwidth(selector_string)

Gets the channel bandwidth of the carrier. This parameter is used to calculate the values of the OFFSET_START_FREQUENCY and OFFSET_STOP_FREQUENCY attributes when you set the OFFSET_FREQUENCY_DEFINITION attribute to Carrier Edge to Meas BW Center or Carrier Edge to Meas BW Edge.

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

The default value is 2 MHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the channel bandwidth of the carrier. This parameter is used to calculate the values of the OFFSET_START_FREQUENCY and OFFSET_STOP_FREQUENCY attributes when you set the OFFSET_FREQUENCY_DEFINITION attribute to Carrier Edge to Meas BW Center or Carrier Edge to Meas BW Edge.

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_enabled(selector_string)

Gets whether to consider the carrier power as part of the total carrier power measurement.

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

The default value is True.

Name (Value)	Description
False (0)	The carrier power is not considered as part of the total carrier power.
True (1)	The carrier power is considered as part of the total carrier power.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemCarrierEnabled):

Specifies whether to consider the carrier power as part of the total carrier 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_carrier_frequency(selector_string)

Gets the center frequency of the carrier, relative to the RF CENTER_FREQUENCY. This value is expressed in Hz.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the center frequency of the carrier, relative to the RF CENTER_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_carrier_integration_bandwidth(selector_string)

Gets the frequency range over which the measurement integrates the carrier power. This value is expressed in Hz.

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

The default value is 2 MHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the frequency range over which the measurement integrates the carrier power. 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_carrier_rbw_filter_auto_bandwidth(selector_string)

Gets whether the measurement computes the resolution bandwidth (RBW) of the carrier.

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

The default value is True.

Name (Value)	Description
False (0)	The measurement uses the RBW that you specify in the SEM Carrier RBW attribute.
True (1)	The measurement computes the RBW.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemCarrierRbwAutoBandwidth):

Specifies whether the measurement computes the resolution bandwidth (RBW) 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_carrier_rbw_filter_bandwidth(selector_string)

Gets the bandwidth of the resolution bandwidth (RBW) filter used to sweep the acquired carrier signal, when you set the CARRIER_RBW_FILTER_AUTO_BANDWIDTH attribute to False. This value is expressed in Hz.

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

The default value is 10 kHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the bandwidth of the resolution bandwidth (RBW) filter used to sweep the acquired carrier signal, when you set the CARRIER_RBW_FILTER_AUTO_BANDWIDTH attribute to False. 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_carrier_rbw_filter_bandwidth_definition(selector_string)

Gets the bandwidth definition that you use to specify the value of the CARRIER_RBW_FILTER_BANDWIDTH attribute.

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

The default value is 3dB.

Name (Value)	Description
3dB (0)	Defines the RBW in terms of the 3 dB bandwidth of the RBW filter. When you set the SEM Carrier RBW Filter Type attribute to FFT Based, RBW is the 3 dB bandwidth of the window specified by the SEM FFT Window attribute.
Bin Width (2)	Defines the RBW in terms of the spectrum bin width computed using an FFT when you set the SEM Carrier RBW Filter Type attribute to FFT Based.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemCarrierRbwFilterBandwidthDefinition):

Specifies the bandwidth definition that you use to specify the value of the CARRIER_RBW_FILTER_BANDWIDTH attribute.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_carrier_rbw_filter_type(selector_string)

Gets the shape of the digital resolution bandwidth (RBW) filter.

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

The default value is Gaussian.

Name (Value)	Description
FFT Based (0)	No RBW filtering is performed.
Gaussian (1)	The RBW filter has a Gaussian response.
Flat (2)	The RBW filter has a flat response.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemCarrierRbwFilterType):

Specifies the shape of the digital resolution bandwidth (RBW) filter.

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_rrc_filter_alpha(selector_string)

Gets the roll-off factor for the root-raised-cosine (RRC) filter to apply on the acquired carrier channel before measuring the carrier channel power.

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

The default value is 0.1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the roll-off factor for the root-raised-cosine (RRC) filter to apply on the acquired carrier channel before measuring the carrier channel power.

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_rrc_filter_enabled(selector_string)

Gets whether to apply the root-raised-cosine (RRC) filter on the acquired carrier channel before measuring the carrier channel power.

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

The default value is False.

Name (Value)	Description
False (0)	The channel power of the acquired carrier channel is measured directly.
True (1)	The measurement applies the RRC filter on the acquired carrier channel before measuring the carrier channel power.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemCarrierRrcFilterEnabled):

Specifies whether to apply the root-raised-cosine (RRC) filter on the acquired carrier channel before measuring the carrier channel power.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_fft_padding(selector_string)

Gets the factor by which the time-domain waveform is zero-padded before FFT. The FFT size is given by the following formula:

waveform size * padding

This attribute is used only when the acquisition span is less than the device instantaneous bandwidth of the device.

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

The default value is -1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the factor by which the time-domain waveform is zero-padded before FFT. The FFT size is given by the following formula:

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_fft_window(selector_string)

Gets the FFT window type to use to reduce spectral leakage.

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

Name (Value)	Description
None (0)	Analyzes transients for which duration is shorter than the window length. You can also use this window type to separate two tones with frequencies close to each other but with almost equal amplitudes.
Flat Top (1)	Measures single-tone amplitudes accurately.
Hanning (2)	Analyzes transients for which duration is longer than the window length. You can also use this window type to provide better frequency resolution for noise measurements.
Hamming (3)	Analyzes closely-spaced sine waves.
Gaussian (4)	Provides a good balance of spectral leakage, frequency resolution, and amplitude attenuation. Hence, this windowing is useful for time-frequency analysis.
Blackman (5)	Analyzes single tone because it has a low maximum side lobe level and a high side lobe roll-off rate.
Blackman-Harris (6)	Useful as a good general purpose window, having side lobe rejection greater than 90 dB and having a moderately wide main lobe.
Kaiser-Bessel (7)	Separates two tones with frequencies close to each other but with widely-differing amplitudes.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemFftWindow):

Specifies the FFT window type to use to reduce spectral leakage.

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)

Gets whether to enable 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 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)

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_carriers(selector_string)

Gets the number of carriers.

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 number of carriers.

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)

Gets the number of offset segments.

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 number of offset segments.

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_absolute_limit_mode(selector_string)

Gets whether the absolute limit mask is a flat line or a line with a slope.

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

The default value is Couple.

Name (Value)	Description
Manual (0)	The line specified by the SEM Offset Abs Limit Start and SEM Offset Abs Limit Stop attribute values as the two ends is considered as the mask.
Couple (1)	The two ends of the line are coupled to the value of the SEM Offset Abs Limit Start attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemOffsetAbsoluteLimitMode):

Specifies whether the absolute limit mask is a flat line or a line with a slope.

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_absolute_limit_start(selector_string)

Gets the absolute power limit corresponding to the beginning of the offset segment. This value is expressed in dBm. This power limit is also set as the stop limit for the offset segment when you set the OFFSET_ABSOLUTE_LIMIT_MODE attribute to Couple.

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

The default value is -10.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the absolute power limit corresponding to the beginning of the offset segment. This value is expressed in dBm. This power limit is also set as the stop limit for the offset segment when you set the OFFSET_ABSOLUTE_LIMIT_MODE attribute to Couple.

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_absolute_limit_stop(selector_string)

Gets the absolute power limit corresponding to the end of the offset segment. This value is expressed in dBm. The measurement ignores this attribute when you set the OFFSET_ABSOLUTE_LIMIT_MODE attribute to Couple.

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

The default value is -10.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the absolute power limit corresponding to the end of the offset segment. This value is expressed in dBm. The measurement ignores this attribute when you set the OFFSET_ABSOLUTE_LIMIT_MODE attribute to Couple.

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_bandwidth_integral(selector_string)

Gets the resolution of the spectrum to compare with spectral mask limits as an integer multiple of the resolution bandwidth (RBW).

If you set this attribute to a value greater than 1, the measurement acquires the spectrum with a narrow resolution and then processes it digitally to get a wider resolution that is equal to the product of the bandwidth integral and the RBW.

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

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the resolution of the spectrum to compare with spectral mask limits as an integer multiple of the resolution bandwidth (RBW).

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_enabled(selector_string)

Gets whether to enable the offset segment for SEM measurement.

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

The default value is True.

Name (Value)	Description
False (0)	Disables the offset segment for the SEM measurement.
True (1)	Enables the offset segment for the SEM measurement.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemOffsetEnabled):

Specifies whether to enable the offset segment 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_offset_frequency_definition(selector_string)

Gets the definition of the start frequency and stop frequency of the offset segments from the nearest carrier channels.

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

The default value is Carrier Center to Meas BW Center.

Name (Value)	Description
Carrier Center to Meas BW Center (0)	The start frequency and stop frequency are defined from the center of the closest carrier channel bandwidth to the center of the offset segment measurement bandwidth. Measurement Bandwidth = Resolution Bandwidth * Bandwidth Integral.
Carrier Center to Meas BW Edge (1)	The start frequency and stop frequency are defined from the center of the closest carrier channel bandwidth to the nearest edge of the offset segment measurement bandwidth.
Carrier Edge to Meas BW Center (2)	The start frequency and stop frequency are defined from the nearest edge of the closest carrier channel bandwidth to the center of the nearest offset segment measurement bandwidth.
Carrier Edge to Meas BW Edge (3)	The start frequency and stop frequency are defined from the nearest edge of the closest carrier channel bandwidth to the edge of the nearest offset segment measurement bandwidth.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemOffsetFrequencyDefinition):

Specifies the definition of the start frequency and stop frequency of the offset segments from the nearest carrier channels.

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_limit_fail_mask(selector_string)

Gets the criteria to determine the measurement fail status.

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

The default value is Absolute.

Name (Value)	Description
Abs AND Rel (0)	The measurement fails if the power in the segment exceeds both the absolute and relative masks.
Abs OR Rel (1)	The measurement fails if the power in the segment exceeds either the absolute or relative mask.
Absolute (2)	The measurement fails if the power in the segment exceeds the absolute mask.
Relative (3)	The measurement fails if the power in the segment exceeds the relative mask.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemOffsetLimitFailMask):

Specifies the criteria to determine the measurement fail status.

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_rbw_filter_auto_bandwidth(selector_string)

Gets whether the measurement computes the resolution bandwidth (RBW).

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

The default value is True.

Name (Value)	Description
False (0)	The measurement uses the RBW that you specify in the SEM Offset RBW attribute.
True (1)	The measurement computes the RBW.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemOffsetRbwAutoBandwidth):

Specifies whether the measurement computes the resolution bandwidth (RBW).

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_rbw_filter_bandwidth(selector_string)

Gets the bandwidth of the resolution bandwidth (RBW) filter used to sweep the acquired offset segment, when you set the OFFSET_RBW_FILTER_AUTO_BANDWIDTH attribute to False. This value is expressed in Hz.

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

The default value is 10 kHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the bandwidth of the resolution bandwidth (RBW) filter used to sweep the acquired offset segment, when you set the OFFSET_RBW_FILTER_AUTO_BANDWIDTH attribute to False. 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_rbw_filter_bandwidth_definition(selector_string)

Gets the bandwidth definition which you use to specify the value of the OFFSET_RBW_FILTER_BANDWIDTH attribute.

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

The default value is 3dB.

Name (Value)	Description
3dB (0)	Defines the RBW in terms of the 3dB bandwidth of the RBW filter. When you set the SEM Offset RBW Filter Type attribute to FFT Based, RBW is the 3dB bandwidth of the window specified by the SEM FFT Window attribute.
Bin Width (2)	Defines the RBW in terms of the spectrum bin width computed using FFT when you set the SEM Offset RBW Filter Type attribute to FFT Based.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemOffsetRbwFilterBandwidthDefinition):

Specifies the bandwidth definition which you use to specify the value of the OFFSET_RBW_FILTER_BANDWIDTH attribute.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_offset_rbw_filter_type(selector_string)

Gets the shape of the digital resolution bandwidth (RBW) filter.

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

The default value is Gaussian.

Name (Value)	Description
FFT Based (0)	No RBW filtering is performed.
Gaussian (1)	The RBW filter has a Gaussian response.
Flat (2)	The RBW filter has a flat response.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemOffsetRbwFilterType):

Specifies the shape of the digital resolution bandwidth (RBW) filter.

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_attenuation(selector_string)

Gets the attenuation relative to the external attenuation specified by the EXTERNAL_ATTENUATION attribute. This value is expressed in dB. Use the SEM Offset Rel Attn attribute to compensate for the variations in external attenuation when offset segments are spread wide in frequency.

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

The default value is 0.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the attenuation relative to the external attenuation specified by the EXTERNAL_ATTENUATION attribute. This value is expressed in dB. Use the SEM Offset Rel Attn attribute to compensate for the variations in external attenuation when offset segments are spread wide in frequency.

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

Gets whether the relative limit mask is a flat line or a line with a slope.

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

The default value is Manual.

Name (Value)	Description
Manual (0)	The line specified by the SEM Offset Rel Limit Start and SEM Offset Rel Limit Stop attribute values as the two ends is considered as the mask.
Couple (1)	The two ends of the line are coupled to the value of the SEM Offset Rel Limit Start attribute.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemOffsetRelativeLimitMode):

Specifies whether the relative limit mask is a flat line or a line with a slope.

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)

Gets the relative power limit corresponding to the beginning of the offset segment. This value is expressed in dB. This power limit is also set as the stop limit for the offset segment when you set the OFFSET_RELATIVE_LIMIT_MODE attribute to Couple.

Use “offset<n>” as the Selector String to configure or read 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 beginning of the offset segment. This value is expressed in dB. This power limit is also set as the stop limit for the offset segment when you set the OFFSET_RELATIVE_LIMIT_MODE attribute to Couple.

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)

Gets the relative power limit corresponding to the end of the offset segment. This value is expressed in dB. The measurement ignores this attribute when you set the OFFSET_RELATIVE_LIMIT_MODE attribute to Couple.

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

The default value is -30.

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. The measurement ignores this attribute when you set the OFFSET_RELATIVE_LIMIT_MODE attribute to Couple.

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)

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 or read this attribute.

The default value is Both.

Name (Value)	Description
Neg (0)	Configures a lower offset segment to the left of the leftmost carrier.
Pos (1)	Configures an upper offset segment to the right of the rightmost 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)

Gets the start frequency of the offset segment relative to the closest configured carrier channel bandwidth center or carrier channel bandwidth edge based on the value of the OFFSET_FREQUENCY_DEFINITION attribute. This value is expressed in Hz.

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

The default value is 1 MHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the start frequency of the offset segment relative to the closest configured carrier channel bandwidth center or carrier channel bandwidth edge based on the value of the OFFSET_FREQUENCY_DEFINITION attribute. 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)

Gets the stop frequency of the offset segment relative to the closest configured carrier channel bandwidth center or carrier channel bandwidth edge based on the value of the OFFSET_FREQUENCY_DEFINITION attribute. This value is expressed in Hz.

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

The default value is 2 MHz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the stop frequency of the offset segment relative to the closest configured carrier channel bandwidth center or carrier channel bandwidth edge based on the value of the OFFSET_FREQUENCY_DEFINITION attribute. 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_power_units(selector_string)

Gets the units for the absolute power.

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

Name (Value)	Description
dBm (0)	The absolute powers are reported in dBm.
dBm/Hz (1)	The absolute powers are reported in dBm/Hz.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemPowerUnits):

Specifies the units for the absolute power.

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_reference_type(selector_string)

Gets whether the power reference is the integrated power or the peak power in the closest carrier channel. The leftmost carrier is the carrier closest to all the lower (negative) offset segments. The rightmost carrier is the carrier closest to all the upper (positive) offset segments.

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

Name (Value)	Description
Integration (0)	The power reference is the integrated power of the closest carrier.
Peak (1)	The power reference is the peak power of the closest carrier.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemReferenceType):

Specifies whether the power reference is the integrated power or the peak power in the closest carrier channel. The leftmost carrier is the carrier closest to all the lower (negative) offset segments. The rightmost carrier is the carrier closest to all the upper (positive) offset segments.

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)

Gets whether the measurement computes the sweep time.

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 calculates the sweep time based on the value of the SEM Offset RBW and SEM Carrier RBW attributes.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.SemSweepTimeAuto):

Specifies whether the measurement computes the sweep time.

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)

Gets the sweep time when you set the SWEEP_TIME_AUTO attribute to False. 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 0.001.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the sweep time when you set the SWEEP_TIME_AUTO attribute to False. 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)

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)

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:

• selector_string (string) – Pass an empty string.

• value (enums.SemAmplitudeCorrectionType, int) – 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.

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)

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)

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)

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 at each frequency bin is retained from one acquisition to the next.
Min (4)	The least power in the spectrum at each frequency bin is retained from one acquisition to the next.

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_carrier_channel_bandwidth(selector_string, value)

Sets the channel bandwidth of the carrier. This parameter is used to calculate the values of the OFFSET_START_FREQUENCY and OFFSET_STOP_FREQUENCY attributes when you set the OFFSET_FREQUENCY_DEFINITION attribute to Carrier Edge to Meas BW Center or Carrier Edge to Meas BW Edge.

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

The default value is 2 MHz.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the channel bandwidth of the carrier. This parameter is used to calculate the values of the OFFSET_START_FREQUENCY and OFFSET_STOP_FREQUENCY attributes when you set the OFFSET_FREQUENCY_DEFINITION attribute to Carrier Edge to Meas BW Center or Carrier Edge to Meas BW Edge.

Returns:

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

Return type:

int

set_carrier_enabled(selector_string, value)

Sets whether to consider the carrier power as part of the total carrier power measurement.

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

The default value is True.

Name (Value)	Description
False (0)	The carrier power is not considered as part of the total carrier power.
True (1)	The carrier power is considered as part of the total carrier power.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.SemCarrierEnabled, int) – Specifies whether to consider the carrier power as part of the total carrier 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_carrier_frequency(selector_string, value)

Sets the center frequency of the carrier, relative to the RF CENTER_FREQUENCY. This value is expressed in Hz.

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

The default value is 0.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the center frequency of the carrier, relative to the RF CENTER_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_carrier_integration_bandwidth(selector_string, value)

Sets the frequency range over which the measurement integrates the carrier power. This value is expressed in Hz.

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

The default value is 2 MHz.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the frequency range over which the measurement integrates the carrier power. 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_carrier_rbw_filter_auto_bandwidth(selector_string, value)

Sets whether the measurement computes the resolution bandwidth (RBW) of the carrier.

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

The default value is True.

Name (Value)	Description
False (0)	The measurement uses the RBW that you specify in the SEM Carrier RBW attribute.
True (1)	The measurement computes the RBW.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.SemCarrierRbwAutoBandwidth, int) – Specifies whether the measurement computes the resolution bandwidth (RBW) 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_carrier_rbw_filter_bandwidth(selector_string, value)

Sets the bandwidth of the resolution bandwidth (RBW) filter used to sweep the acquired carrier signal, when you set the CARRIER_RBW_FILTER_AUTO_BANDWIDTH attribute to False. This value is expressed in Hz.

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

The default value is 10 kHz.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the bandwidth of the resolution bandwidth (RBW) filter used to sweep the acquired carrier signal, when you set the CARRIER_RBW_FILTER_AUTO_BANDWIDTH attribute to False. 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_carrier_rbw_filter_bandwidth_definition(selector_string, value)

Sets the bandwidth definition that you use to specify the value of the CARRIER_RBW_FILTER_BANDWIDTH attribute.

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

The default value is 3dB.

Name (Value)	Description
3dB (0)	Defines the RBW in terms of the 3 dB bandwidth of the RBW filter. When you set the SEM Carrier RBW Filter Type attribute to FFT Based, RBW is the 3 dB bandwidth of the window specified by the SEM FFT Window attribute.
Bin Width (2)	Defines the RBW in terms of the spectrum bin width computed using an FFT when you set the SEM Carrier RBW Filter Type attribute to FFT Based.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.SemCarrierRbwFilterBandwidthDefinition, int) – Specifies the bandwidth definition that you use to specify the value of the CARRIER_RBW_FILTER_BANDWIDTH attribute.

Returns:

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

Return type:

int

set_carrier_rbw_filter_type(selector_string, value)

Sets the shape of the digital resolution bandwidth (RBW) filter.

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

The default value is Gaussian.

Name (Value)	Description
FFT Based (0)	No RBW filtering is performed.
Gaussian (1)	The RBW filter has a Gaussian response.
Flat (2)	The RBW filter has a flat response.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.SemCarrierRbwFilterType, int) – Specifies the shape of the digital resolution bandwidth (RBW) filter.

Returns:

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

Return type:

int

set_carrier_rrc_filter_alpha(selector_string, value)

Sets the roll-off factor for the root-raised-cosine (RRC) filter to apply on the acquired carrier channel before measuring the carrier channel power.

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

The default value is 0.1.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the roll-off factor for the root-raised-cosine (RRC) filter to apply on the acquired carrier channel before measuring the carrier channel power.

Returns:

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

Return type:

int

set_carrier_rrc_filter_enabled(selector_string, value)

Sets whether to apply the root-raised-cosine (RRC) filter on the acquired carrier channel before measuring the carrier channel power.

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

The default value is False.

Name (Value)	Description
False (0)	The channel power of the acquired carrier channel is measured directly.
True (1)	The measurement applies the RRC filter on the acquired carrier channel before measuring the carrier channel power.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.SemCarrierRrcFilterEnabled, int) – Specifies whether to apply the root-raised-cosine (RRC) filter on the acquired carrier channel before measuring the carrier channel power.

Returns:

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

Return type:

int

set_fft_padding(selector_string, value)

Sets the factor by which the time-domain waveform is zero-padded before FFT. The FFT size is given by the following formula:

waveform size * padding

This attribute is used only when the acquisition span is less than the device instantaneous bandwidth of the device.

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

The default value is -1.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the factor by which the time-domain waveform is zero-padded before FFT. The FFT size is given by the following formula:

Returns:

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

Return type:

int

set_fft_window(selector_string, value)

Sets the FFT window type to use to reduce spectral leakage.

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

Name (Value)	Description
None (0)	Analyzes transients for which duration is shorter than the window length. You can also use this window type to separate two tones with frequencies close to each other but with almost equal amplitudes.
Flat Top (1)	Measures single-tone amplitudes accurately.
Hanning (2)	Analyzes transients for which duration is longer than the window length. You can also use this window type to provide better frequency resolution for noise measurements.
Hamming (3)	Analyzes closely-spaced sine waves.
Gaussian (4)	Provides a good balance of spectral leakage, frequency resolution, and amplitude attenuation. Hence, this windowing is useful for time-frequency analysis.
Blackman (5)	Analyzes single tone because it has a low maximum side lobe level and a high side lobe roll-off rate.
Blackman-Harris (6)	Useful as a good general purpose window, having side lobe rejection greater than 90 dB and having a moderately wide main lobe.
Kaiser-Bessel (7)	Separates two tones with frequencies close to each other but with widely-differing amplitudes.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.SemFftWindow, int) – Specifies the FFT window type to use to reduce spectral leakage.

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)

Sets whether to enable 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 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)

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_carriers(selector_string, value)

Sets the number of carriers.

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 number of carriers.

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)

Sets the number of offset segments.

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 number of offset segments.

Returns:

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

Return type:

int

set_offset_absolute_limit_mode(selector_string, value)

Sets whether the absolute limit mask is a flat line or a line with a slope.

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

The default value is Couple.

Name (Value)	Description
Manual (0)	The line specified by the SEM Offset Abs Limit Start and SEM Offset Abs Limit Stop attribute values as the two ends is considered as the mask.
Couple (1)	The two ends of the line are coupled to the value of the SEM Offset Abs Limit Start attribute.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.SemOffsetAbsoluteLimitMode, int) – Specifies whether the absolute limit mask is a flat line or a line with a slope.

Returns:

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

Return type:

int

set_offset_absolute_limit_start(selector_string, value)

Sets the absolute power limit corresponding to the beginning of the offset segment. This value is expressed in dBm. This power limit is also set as the stop limit for the offset segment when you set the OFFSET_ABSOLUTE_LIMIT_MODE attribute to Couple.

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

The default value is -10.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the absolute power limit corresponding to the beginning of the offset segment. This value is expressed in dBm. This power limit is also set as the stop limit for the offset segment when you set the OFFSET_ABSOLUTE_LIMIT_MODE attribute to Couple.

Returns:

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

Return type:

int

set_offset_absolute_limit_stop(selector_string, value)

Sets the absolute power limit corresponding to the end of the offset segment. This value is expressed in dBm. The measurement ignores this attribute when you set the OFFSET_ABSOLUTE_LIMIT_MODE attribute to Couple.

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

The default value is -10.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the absolute power limit corresponding to the end of the offset segment. This value is expressed in dBm. The measurement ignores this attribute when you set the OFFSET_ABSOLUTE_LIMIT_MODE attribute to Couple.

Returns:

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

Return type:

int

set_offset_bandwidth_integral(selector_string, value)

Sets the resolution of the spectrum to compare with spectral mask limits as an integer multiple of the resolution bandwidth (RBW).

If you set this attribute to a value greater than 1, the measurement acquires the spectrum with a narrow resolution and then processes it digitally to get a wider resolution that is equal to the product of the bandwidth integral and the RBW.

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

The default value is 1.

Parameters:

• selector_string (string) – Pass an empty string.

• value (int) – Specifies the resolution of the spectrum to compare with spectral mask limits as an integer multiple of the resolution bandwidth (RBW).

Returns:

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

Return type:

int

set_offset_enabled(selector_string, value)

Sets whether to enable the offset segment for SEM measurement.

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

The default value is True.

Name (Value)	Description
False (0)	Disables the offset segment for the SEM measurement.
True (1)	Enables the offset segment for the SEM measurement.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.SemOffsetEnabled, int) – Specifies whether to enable the offset segment 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_offset_frequency_definition(selector_string, value)

Sets the definition of the start frequency and stop frequency of the offset segments from the nearest carrier channels.

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

The default value is Carrier Center to Meas BW Center.

Name (Value)	Description
Carrier Center to Meas BW Center (0)	The start frequency and stop frequency are defined from the center of the closest carrier channel bandwidth to the center of the offset segment measurement bandwidth. Measurement Bandwidth = Resolution Bandwidth * Bandwidth Integral.
Carrier Center to Meas BW Edge (1)	The start frequency and stop frequency are defined from the center of the closest carrier channel bandwidth to the nearest edge of the offset segment measurement bandwidth.
Carrier Edge to Meas BW Center (2)	The start frequency and stop frequency are defined from the nearest edge of the closest carrier channel bandwidth to the center of the nearest offset segment measurement bandwidth.
Carrier Edge to Meas BW Edge (3)	The start frequency and stop frequency are defined from the nearest edge of the closest carrier channel bandwidth to the edge of the nearest offset segment measurement bandwidth.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.SemOffsetFrequencyDefinition, int) – Specifies the definition of the start frequency and stop frequency of the offset segments from the nearest carrier channels.

Returns:

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

Return type:

int

set_offset_limit_fail_mask(selector_string, value)

Sets the criteria to determine the measurement fail status.

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

The default value is Absolute.

Name (Value)	Description
Abs AND Rel (0)	The measurement fails if the power in the segment exceeds both the absolute and relative masks.
Abs OR Rel (1)	The measurement fails if the power in the segment exceeds either the absolute or relative mask.
Absolute (2)	The measurement fails if the power in the segment exceeds the absolute mask.
Relative (3)	The measurement fails if the power in the segment exceeds the relative mask.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.SemOffsetLimitFailMask, int) – Specifies the criteria to determine the measurement fail status.

Returns:

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

Return type:

int

set_offset_rbw_filter_auto_bandwidth(selector_string, value)

Sets whether the measurement computes the resolution bandwidth (RBW).

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

The default value is True.

Name (Value)	Description
False (0)	The measurement uses the RBW that you specify in the SEM Offset RBW attribute.
True (1)	The measurement computes the RBW.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.SemOffsetRbwAutoBandwidth, int) – Specifies whether the measurement computes the resolution bandwidth (RBW).

Returns:

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

Return type:

int

set_offset_rbw_filter_bandwidth(selector_string, value)

Sets the bandwidth of the resolution bandwidth (RBW) filter used to sweep the acquired offset segment, when you set the OFFSET_RBW_FILTER_AUTO_BANDWIDTH attribute to False. This value is expressed in Hz.

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

The default value is 10 kHz.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the bandwidth of the resolution bandwidth (RBW) filter used to sweep the acquired offset segment, when you set the OFFSET_RBW_FILTER_AUTO_BANDWIDTH attribute to False. 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_rbw_filter_bandwidth_definition(selector_string, value)

Sets the bandwidth definition which you use to specify the value of the OFFSET_RBW_FILTER_BANDWIDTH attribute.

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

The default value is 3dB.

Name (Value)	Description
3dB (0)	Defines the RBW in terms of the 3dB bandwidth of the RBW filter. When you set the SEM Offset RBW Filter Type attribute to FFT Based, RBW is the 3dB bandwidth of the window specified by the SEM FFT Window attribute.
Bin Width (2)	Defines the RBW in terms of the spectrum bin width computed using FFT when you set the SEM Offset RBW Filter Type attribute to FFT Based.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.SemOffsetRbwFilterBandwidthDefinition, int) – Specifies the bandwidth definition which you use to specify the value of the OFFSET_RBW_FILTER_BANDWIDTH attribute.

Returns:

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

Return type:

int

set_offset_rbw_filter_type(selector_string, value)

Sets the shape of the digital resolution bandwidth (RBW) filter.

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

The default value is Gaussian.

Name (Value)	Description
FFT Based (0)	No RBW filtering is performed.
Gaussian (1)	The RBW filter has a Gaussian response.
Flat (2)	The RBW filter has a flat response.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.SemOffsetRbwFilterType, int) – Specifies the shape of the digital resolution bandwidth (RBW) filter.

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_attenuation(selector_string, value)

Sets the attenuation relative to the external attenuation specified by the EXTERNAL_ATTENUATION attribute. This value is expressed in dB. Use the SEM Offset Rel Attn attribute to compensate for the variations in external attenuation when offset segments are spread wide in frequency.

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

The default value is 0.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the attenuation relative to the external attenuation specified by the EXTERNAL_ATTENUATION attribute. This value is expressed in dB. Use the SEM Offset Rel Attn attribute to compensate for the variations in external attenuation when offset segments are spread wide in frequency.

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

Sets whether the relative limit mask is a flat line or a line with a slope.

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

The default value is Manual.

Name (Value)	Description
Manual (0)	The line specified by the SEM Offset Rel Limit Start and SEM Offset Rel Limit Stop attribute values as the two ends is considered as the mask.
Couple (1)	The two ends of the line are coupled to the value of the SEM Offset Rel Limit Start attribute.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.SemOffsetRelativeLimitMode, int) – Specifies whether the relative limit mask is a flat line or a line with a slope.

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)

Sets the relative power limit corresponding to the beginning of the offset segment. This value is expressed in dB. This power limit is also set as the stop limit for the offset segment when you set the OFFSET_RELATIVE_LIMIT_MODE attribute to Couple.

Use “offset<n>” as the Selector String to configure or read 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 beginning of the offset segment. This value is expressed in dB. This power limit is also set as the stop limit for the offset segment when you set the OFFSET_RELATIVE_LIMIT_MODE attribute to Couple.

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)

Sets the relative power limit corresponding to the end of the offset segment. This value is expressed in dB. The measurement ignores this attribute when you set the OFFSET_RELATIVE_LIMIT_MODE attribute to Couple.

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

The default value is -30.

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. The measurement ignores this attribute when you set the OFFSET_RELATIVE_LIMIT_MODE attribute to Couple.

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)

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 or read this attribute.

The default value is Both.

Name (Value)	Description
Neg (0)	Configures a lower offset segment to the left of the leftmost carrier.
Pos (1)	Configures an upper offset segment to the right of the rightmost 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)

Sets the start frequency of the offset segment relative to the closest configured carrier channel bandwidth center or carrier channel bandwidth edge based on the value of the OFFSET_FREQUENCY_DEFINITION attribute. This value is expressed in Hz.

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

The default value is 1 MHz.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the start frequency of the offset segment relative to the closest configured carrier channel bandwidth center or carrier channel bandwidth edge based on the value of the OFFSET_FREQUENCY_DEFINITION attribute. 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)

Sets the stop frequency of the offset segment relative to the closest configured carrier channel bandwidth center or carrier channel bandwidth edge based on the value of the OFFSET_FREQUENCY_DEFINITION attribute. This value is expressed in Hz.

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

The default value is 2 MHz.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the stop frequency of the offset segment relative to the closest configured carrier channel bandwidth center or carrier channel bandwidth edge based on the value of the OFFSET_FREQUENCY_DEFINITION attribute. 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_power_units(selector_string, value)

Sets the units for the absolute power.

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

Name (Value)	Description
dBm (0)	The absolute powers are reported in dBm.
dBm/Hz (1)	The absolute powers are reported in dBm/Hz.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.SemPowerUnits, int) – Specifies the units for the absolute power.

Returns:

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

Return type:

int

set_reference_type(selector_string, value)

Sets whether the power reference is the integrated power or the peak power in the closest carrier channel. The leftmost carrier is the carrier closest to all the lower (negative) offset segments. The rightmost carrier is the carrier closest to all the upper (positive) offset segments.

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

Name (Value)	Description
Integration (0)	The power reference is the integrated power of the closest carrier.
Peak (1)	The power reference is the peak power of the closest carrier.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.SemReferenceType, int) – Specifies whether the power reference is the integrated power or the peak power in the closest carrier channel. The leftmost carrier is the carrier closest to all the lower (negative) offset segments. The rightmost carrier is the carrier closest to all the upper (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

set_sweep_time_auto(selector_string, value)

Sets whether the measurement computes the sweep time.

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 calculates the sweep time based on the value of the SEM Offset RBW and SEM Carrier RBW attributes.

Parameters:

• selector_string (string) – Pass an empty string.

• value (enums.SemSweepTimeAuto, int) – Specifies whether the measurement computes the sweep time.

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)

Sets the sweep time when you set the SWEEP_TIME_AUTO attribute to False. 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 0.001.

Parameters:

• selector_string (string) – Pass an empty string.

• value (float) – Specifies the sweep time when you set the SWEEP_TIME_AUTO attribute to False. 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