RFmxSpecAnMXObwConfiguration Class
- Updated2025-10-13
- 4 minute(s) read
Provides methods to configure the occupied bandwidth (OBW) measurement.
Derives from
Syntax
Namespace: NationalInstruments.RFmx.SpecAnMX
public class RFmxSpecAnMXObwConfiguration : RFmxSpecAnMXSubObject
Remarks
For more information about RFmx SpecAn, refer to the RFmx SpecAn Help.
Thread Safety
Any public static members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Methods
| Name | Description |
|---|---|
| ConfigureAveraging(string, RFmxSpecAnMXObwAveragingEnabled, int, RFmxSpecAnMXObwAveragingType) | Configures averaging for the occupied bandwidth (OBW) measurement. |
| ConfigureBandwidthPercentage(string, double) | Configures the percentage of the total power that is contained in the occupied bandwidth (OBW). |
| ConfigureFft(string, RFmxSpecAnMXObwFftWindow, double) | Configures window and FFT to obtain a spectrum for the occupied bandwidth (OBW) measurement. |
| ConfigurePowerUnits(string, RFmxSpecAnMXObwPowerUnits) | Configures the units for the absolute power. |
| ConfigureRbwFilter(string, RFmxSpecAnMXObwRbwAutoBandwidth, double, RFmxSpecAnMXObwRbwFilterType) | Configures the resolution bandwidth (RBW) filter. |
| ConfigureSpan(string, double) | Configures the frequency range, in hertz (Hz), around the center frequency, to acquire for the measurement. |
| ConfigureSweepTime(string, RFmxSpecAnMXObwSweepTimeAuto, double) | Configures the sweep time. |
| GetAllTracesEnabled(string, out bool) | Gets whether the traces to be stored and retrieved after performing the occupied bandwidth (OBW) are enabled. |
| GetAmplitudeCorrectionType(string, out RFmxSpecAnMXObwAmplitudeCorrectionType) | 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 _RFmxInstrCfgExternalAttenuationTable function to configure the external attenuation table. |
| GetAveragingCount(string, out int) | Gets the number of acquisitions used for averaging. |
| GetAveragingEnabled(string, out RFmxSpecAnMXObwAveragingEnabled) | Gets whether averaging for the occupied bandwidth (OBW) measurement is enabled. |
| GetAveragingType(string, out RFmxSpecAnMXObwAveragingType) | Gets the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for occupied bandwidth (OBW) measurement. |
| GetBandwidthPercentage(string, out double) | Gets the percentage of the total power that is contained in the frequency range defined by the occupied bandwidth (OBW). |
| GetFftPadding(string, out double) | 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 method is applicable only when the acquisition span is less than the device instantaneous bandwidth of the device. |
| GetFftWindow(string, out RFmxSpecAnMXObwFftWindow) | Gets the FFT window type used to reduce spectral leakage. |
| GetMeasurementEnabled(string, out bool) | Gets whether occupied bandwidth (OBW) measurement is enabled. |
| GetNumberOfAnalysisThreads(string, out int) | Gets the maximum number of threads used for parallelism for occupied bandwidth (OBW) measurement. |
| GetPowerUnits(string, out RFmxSpecAnMXObwPowerUnits) | Gets the units for the absolute power. |
| GetRbwFilterAutoBandwidth(string, out RFmxSpecAnMXObwRbwAutoBandwidth) | Gets whether the measurement computes the resolution bandwidth (RBW). |
| GetRbwFilterBandwidth(string, out double) | Gets the bandwidth, in hertz (Hz), of the resolution bandwidth (RBW) filter used to sweep the acquired signal. |
| GetRbwFilterBandwidthDefinition(string, out RFmxSpecAnMXObwRbwFilterBandwidthDefinition) | Gets the bandwidth definition which you use to specify the value of the SetRbwFilterBandwidth(string, double) method. |
| GetRbwFilterType(string, out RFmxSpecAnMXObwRbwFilterType) | Gets the shape of the digital resolution bandwidth (RBW) filter. |
| GetSpan(string, out double) | Gets the frequency range, in hertz (Hz), around the center frequency, to acquire for the measurement. |
| GetSweepTimeAuto(string, out RFmxSpecAnMXObwSweepTimeAuto) | Gets whether the measurement computes the sweep time. |
| GetSweepTimeInterval(string, out double) | Gets the sweep time, in seconds. |
| SetAllTracesEnabled(string, bool) | Sets whether to enable the traces to be stored and retrieved after performing the occupied bandwidth (OBW) measurement. |
| SetAmplitudeCorrectionType(string, RFmxSpecAnMXObwAmplitudeCorrectionType) | 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 _RFmxInstrCfgExternalAttenuationTable function to configure the external attenuation table. |
| SetAveragingCount(string, int) | Sets the number of acquisitions used for averaging when you set the SetAveragingEnabled(string, RFmxSpecAnMXObwAveragingEnabled) method to True. |
| SetAveragingEnabled(string, RFmxSpecAnMXObwAveragingEnabled) | Sets whether to enable averaging for the occupied bandwidth (OBW) measurement. |
| SetAveragingType(string, RFmxSpecAnMXObwAveragingType) | Sets the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for occupied bandwidth (OBW) measurement. |
| SetBandwidthPercentage(string, double) | Sets the percentage of the total power that is contained in the frequency range defined by the occupied bandwidth (OBW). |
| SetFftPadding(string, double) | 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 method is applicable only when the acquisition span is less than the device instantaneous bandwidth of the device. |
| SetFftWindow(string, RFmxSpecAnMXObwFftWindow) | Sets the FFT window type used to reduce spectral leakage. |
| SetMeasurementEnabled(string, bool) | Sets whether to enable occupied bandwidth (OBW) measurement. |
| SetNumberOfAnalysisThreads(string, int) | Sets the maximum number of threads used for parallelism for occupied bandwidth (OBW) measurement. |
| SetPowerUnits(string, RFmxSpecAnMXObwPowerUnits) | Sets the units for the absolute power. |
| SetRbwFilterAutoBandwidth(string, RFmxSpecAnMXObwRbwAutoBandwidth) | Sets whether the measurement computes the resolution bandwidth (RBW). |
| SetRbwFilterBandwidth(string, double) | Sets the bandwidth, in hertz (Hz), of the resolution bandwidth (RBW) filter used to sweep the acquired signal. |
| SetRbwFilterBandwidthDefinition(string, RFmxSpecAnMXObwRbwFilterBandwidthDefinition) | Sets the bandwidth definition which you use to specify the value of the SetRbwFilterBandwidth(string, double) method. |
| SetRbwFilterType(string, RFmxSpecAnMXObwRbwFilterType) | Sets the shape of the digital resolution bandwidth (RBW) filter. |
| SetSpan(string, double) | Sets the frequency range, in hertz (Hz), around the center frequency, to acquire for the measurement. |
| SetSweepTimeAuto(string, RFmxSpecAnMXObwSweepTimeAuto) | Sets whether the measurement computes the sweep time. |
| SetSweepTimeInterval(string, double) | Sets the sweep time, in seconds, when you set the SetSweepTimeAuto(string, RFmxSpecAnMXObwSweepTimeAuto) method to False. |