ObwConfiguration

Provides methods to configure the Obw measurement.

class nirfmxspecan.obw_configuration.ObwConfiguration(signal_obj)[source]

Bases: object

Provides methods to configure the Obw measurement.

configure_averaging(selector_string, averaging_enabled, averaging_count, averaging_type)[source]

Configures averaging for the occupied bandwidth (OBW) 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.ObwAveragingEnabled, 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.ObwAveragingType, 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_bandwidth_percentage(selector_string, bandwidth_percentage)[source]

Configures the percentage of the total power that is contained in the occupied bandwidth (OBW).

Parameters:

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

  • bandwidth_percentage (float) – This parameter specifies the percentage of the total power that is contained in the OBW. The default value is 99%.

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

Configures window and FFT to obtain a spectrum for the occupied bandwidth (OBW) 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.ObwFftWindow, 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_power_units(selector_string, power_units)[source]

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.ObwPowerUnits, 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_rbw_filter(selector_string, rbw_auto, rbw, rbw_filter_type)[source]

Configures the resolution bandwidth (RBW) filter.

Parameters:

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

  • rbw_auto (enums.ObwRbwAutoBandwidth, int) –

    This parameter specifies whether the measurement computes the RBW. Refer to the RBW and Sweep Time section in the Spectral Measurements Concepts 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 of the RBW filter used to sweep the acquired signal, when you set the RBW Auto parameter to False. This value is expressed in Hz. The default value is 10 kHz.

  • rbw_filter_type (enums.ObwRbwFilterType, 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_span(selector_string, span)[source]

Configures the frequency range, in Hz, around the center frequency, to acquire for the measurement.

Parameters:

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

  • span (float) – This parameter specifies the frequency range, in Hz, around the center frequency, to acquire for the measurement. The default value is 1 MHz.

Returns:

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

Return type:

int

configure_sweep_time(selector_string, sweep_time_auto, sweep_time_interval)[source]

Configures the sweep time.

Parameters:

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

  • sweep_time_auto (enums.ObwSweepTimeAuto, 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 OBW 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)[source]

Gets whether to enable the traces to be stored and retrieved after performing the OBW.

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

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_amplitude_correction_type(selector_string)[source]

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

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

The default value is RF Center Frequency.

Name (Value)

Description

RF Center Frequency (0)

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

Spectrum Frequency Bin (1)

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

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ObwAmplitudeCorrectionType):

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

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_averaging_count(selector_string)[source]

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

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

The default value is 10.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

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

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_averaging_enabled(selector_string)[source]

Gets whether to enable averaging for the OBW 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 OBW measurement uses the OBW Averaging Count attribute as the number of acquisitions over which the OBW measurement is averaged.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ObwAveragingEnabled):

Specifies whether to enable averaging for the OBW measurement.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_averaging_type(selector_string)[source]

Gets the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for OBW 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.ObwAveragingType):

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

Gets the percentage of the total power that is contained in the OBW.

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 99%.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the percentage of the total power that is contained in the OBW.

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

Gets the factor by which the time-domain waveform is zero-padded before fast Fourier transform (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 fast Fourier transform (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)[source]

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.ObwFftWindow):

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

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

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_number_of_analysis_threads(selector_string)[source]

Gets the maximum number of threads used for parallelism for the OBW measurement.

The number of threads can range from 1 to the number of physical cores. The number of threads you set may not be used in calculations. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations.

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

The default value is 1.

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (int):

Specifies the maximum number of threads used for parallelism for the OBW measurement.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_power_units(selector_string)[source]

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.ObwPowerUnits):

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

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

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 RBW that you specify in the OBW RBW attribute.

True (1)

The measurement computes the RBW.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ObwRbwAutoBandwidth):

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

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

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 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 signal, when you set the 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_rbw_filter_bandwidth_definition(selector_string)[source]

Gets the bandwidth definition that you use to specify the value of the RBW_FILTER_BANDWIDTH 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 OBW RBW Filter Type attribute to FFT Based, RBW is the 3 dB bandwidth of the window specified by the OBW FFT Window attribute.

Bin Width (2)

Defines the RBW in terms of the spectrum bin width computed using an FFT when you set the OBW RBW Filter Type attribute to FFT Based.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ObwRbwFilterBandwidthDefinition):

Specifies the bandwidth definition that you use to specify the value of the 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_rbw_filter_type(selector_string)[source]

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

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 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.ObwRbwFilterType):

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

Gets the frequency range around the center frequency, to acquire for the measurement. This value is expressed in Hz.

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

Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (float):

Specifies the frequency range around the center frequency, to acquire for the measurement. This value is expressed in Hz.

error_code (int):

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

Return type:

Tuple (attr_val, error_code)

get_sweep_time_auto(selector_string)[source]

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 OBW Sweep Time attribute.

True (1)

The measurement calculates the sweep time based on the value of the OBW RBW attribute.
Parameters:

selector_string (string) – Pass an empty string.

Returns:

attr_val (enums.ObwSweepTimeAuto):

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

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

Sets whether to enable the traces to be stored and retrieved after performing the OBW.

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

Returns:

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

Return type:

int

set_amplitude_correction_type(selector_string, value)[source]

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

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

The default value is RF Center Frequency.

Name (Value)

Description

RF Center Frequency (0)

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

Spectrum Frequency Bin (1)

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

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

Return type:

int

set_averaging_count(selector_string, value)[source]

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

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

The default value is 10.

Parameters:

  • selector_string (string) – Pass an empty string.

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

Returns:

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

Return type:

int

set_averaging_enabled(selector_string, value)[source]

Sets whether to enable averaging for the OBW 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 OBW measurement uses the OBW Averaging Count attribute as the number of acquisitions over which the OBW measurement is averaged.
Parameters:

  • selector_string (string) – Pass an empty string.

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

Returns:

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

Return type:

int

set_averaging_type(selector_string, value)[source]

Sets the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for OBW 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.ObwAveragingType, int) – Specifies the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for OBW measurement.

Returns:

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

Return type:

int

set_bandwidth_percentage(selector_string, value)[source]

Sets the percentage of the total power that is contained in the OBW.

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 99%.

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the percentage of the total power that is contained in the OBW.

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

Sets the factor by which the time-domain waveform is zero-padded before fast Fourier transform (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 fast Fourier transform (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)[source]

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.ObwFftWindow, 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)[source]

Sets whether to enable OBW 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 OBW measurement.

Returns:

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

Return type:

int

set_number_of_analysis_threads(selector_string, value)[source]

Sets the maximum number of threads used for parallelism for the OBW measurement.

The number of threads can range from 1 to the number of physical cores. The number of threads you set may not be used in calculations. The actual number of threads used depends on the problem size, system resources, data availability, and other considerations.

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

The default value is 1.

Parameters:

  • selector_string (string) – Pass an empty string.

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

Returns:

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

Return type:

int

set_power_units(selector_string, value)[source]

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.ObwPowerUnits, 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_rbw_filter_auto_bandwidth(selector_string, value)[source]

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

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 RBW that you specify in the OBW RBW attribute.

True (1)

The measurement computes the RBW.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ObwRbwAutoBandwidth, 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_rbw_filter_bandwidth(selector_string, value)[source]

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

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 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 signal, when you set the 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_rbw_filter_bandwidth_definition(selector_string, value)[source]

Sets the bandwidth definition that you use to specify the value of the RBW_FILTER_BANDWIDTH 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 OBW RBW Filter Type attribute to FFT Based, RBW is the 3 dB bandwidth of the window specified by the OBW FFT Window attribute.

Bin Width (2)

Defines the RBW in terms of the spectrum bin width computed using an FFT when you set the OBW RBW Filter Type attribute to FFT Based.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ObwRbwFilterBandwidthDefinition, int) – Specifies the bandwidth definition that you use to specify the value of the 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_rbw_filter_type(selector_string, value)[source]

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

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 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.ObwRbwFilterType, 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_span(selector_string, value)[source]

Sets the frequency range around the center frequency, to acquire for the measurement. This value is expressed in Hz.

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

Parameters:

  • selector_string (string) – Pass an empty string.

  • value (float) – Specifies the frequency range around the center frequency, to acquire for the measurement. This value is expressed in Hz.

Returns:

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

Return type:

int

set_sweep_time_auto(selector_string, value)[source]

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 OBW Sweep Time attribute.

True (1)

The measurement calculates the sweep time based on the value of the OBW RBW attribute.
Parameters:

  • selector_string (string) – Pass an empty string.

  • value (enums.ObwSweepTimeAuto, 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)[source]

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