RFmxSpecAnMXSpectrumConfiguration Class
- Updated2025-10-13
- 6 minute(s) read
Provides methods to configure the Spectrum measurement.
Derives from
Syntax
Namespace: NationalInstruments.RFmx.SpecAnMX
public class RFmxSpecAnMXSpectrumConfiguration : 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, RFmxSpecAnMXSpectrumAveragingEnabled, int, RFmxSpecAnMXSpectrumAveragingType) | Configures averaging for the Spectrum measurement. |
| ConfigureDetector(string, RFmxSpecAnMXSpectrumDetectorType, int) | Configures the detector settings, including detector type and the number of points to be detected. |
| ConfigureFft(string, RFmxSpecAnMXSpectrumFftWindow, double) | Configures window and FFT to obtain a spectrum for the Spectrum measurement. |
| ConfigureFrequencyStartStop(string, double, double) | Configures the start frequency and stop frequency for the Spectrum measurement. |
| ConfigureMeasurementMethod(string, RFmxSpecAnMXSpectrumMeasurementMethod) | Configures the method for performing the Spectrum measurement. |
| ConfigureNoiseCompensationEnabled(string, RFmxSpecAnMXSpectrumNoiseCompensationEnabled) | Configures compensation of the channel powers for the inherent noise floor of the signal analyzer. |
| ConfigurePowerUnits(string, RFmxSpecAnMXSpectrumPowerUnits) | Configures the units for the absolute power. |
| ConfigureRbwFilter(string, RFmxSpecAnMXSpectrumRbwAutoBandwidth, double, RFmxSpecAnMXSpectrumRbwFilterType) | Configures the resolution bandwidth (RBW) filter. |
| ConfigureSpan(string, double) | Configures the frequency range, in hertz (Hz), around the center frequency, to acquire for the Spectrum measurement. |
| ConfigureSweepTime(string, RFmxSpecAnMXSpectrumSweepTimeAuto, double) | Configures the sweep time. |
| ConfigureVbwFilter(string, RFmxSpecAnMXSpectrumVbwFilterAutoBandwidth, double, double) | Configures the VBW settings including VBW Auto, VBW(Hz) and VBW to RBW ratio. |
| GetAmplitudeCorrectionType(string, out RFmxSpecAnMXSpectrumAmplitudeCorrectionType) | 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. |
| GetAnalysisInput(string, out RFmxSpecAnMXSpectrumAnalysisInput) | Gets whether to analyze just the real I or Q component of the acquired IQ data, or analyze the complex IQ data. |
| GetAveragingCount(string, out int) | Gets the number of acquisitions used for averaging. |
| GetAveragingEnabled(string, out RFmxSpecAnMXSpectrumAveragingEnabled) | Gets whether to enable averaging for the Spectrum measurement. |
| GetAveragingType(string, out RFmxSpecAnMXSpectrumAveragingType) | Gets the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for spectrum measurement. |
| GetDetectorPoints(string, out int) | Gets the number of trace points after the detector is applied. |
| GetDetectorType(string, out RFmxSpecAnMXSpectrumDetectorType) | Gets the type of detector to be used. |
| GetFftOverlap(string, out double) | Gets the samples to overlap between the consecutive chunks as a percentage of the SpectrumSequentialFftSize method when you set the SpectrumMeasurementMethod method to SequentialFft and the SpectrumFftOverlapMode method to UserDefined. This value is expressed as a percentage. |
| GetFftOverlapMode(string, out RFmxSpecAnMXSpectrumFftOverlapMode) | Gets the overlap mode when you set the SpectrumMeasurementMethod method to SequentialFft. |
| GetFftOverlapType(string, out RFmxSpecAnMXSpectrumFftOverlapType) | Gets the overlap type when you set the SpectrumMeasurementMethod method to SequentialFft. |
| 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 RFmxSpecAnMXSpectrumFftWindow) | Gets the FFT window type used to reduce spectral leakage. |
| GetMeasurementEnabled(string, out bool) | Gets whether Spectrum measurement is enabled. |
| GetMeasurementMethod(string, out RFmxSpecAnMXSpectrumMeasurementMethod) | Gets the method for performing the Spectrum measurement. |
| GetMeasurementMode(string, out RFmxSpecAnMXSpectrumMeasurementMode) | Gets whether the measurement calibrates the noise floor of analyzer or performs the spectrum measurement. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information. |
| GetNoiseCalibrationAveragingAuto(string, out RFmxSpecAnMXSpectrumNoiseCalibrationAveragingAuto) | Gets whether RFmx automatically computes the averaging count used for instrument noise calibration. |
| GetNoiseCalibrationAveragingCount(string, out int) | Gets the averaging count used for noise calibration when you set the SetNoiseCalibrationAveragingAuto(string, RFmxSpecAnMXSpectrumNoiseCalibrationAveragingAuto) method to False. |
| GetNoiseCalibrationMode(string, out RFmxSpecAnMXSpectrumNoiseCalibrationMode) | Gets whether the noise calibration and measurement is performed manually by the user or automatically by RFmx. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information. |
| GetNoiseCompensationEnabled(string, out RFmxSpecAnMXSpectrumNoiseCompensationEnabled) | Gets whether to enable compensation of the channel powers for the inherent noise floor of the signal analyzer. |
| GetNoiseCompensationType(string, out RFmxSpecAnMXSpectrumNoiseCompensationType) | Gets the noise compensation type. Refer to the Noise Compensation Algorithm topic for more information. |
| GetNumberOfAnalysisThreads(string, out int) | Gets the maximum number of threads used for parallelism for Spectrum measurement. |
| GetPowerUnits(string, out RFmxSpecAnMXSpectrumPowerUnits) | Gets the units for the absolute power. |
| GetRbwFilterAutoBandwidth(string, out RFmxSpecAnMXSpectrumRbwAutoBandwidth) | Gets whether the resolution bandwidth (RBW) is computed by the measurement. |
| GetRbwFilterBandwidth(string, out double) | Gets the bandwidth, in hertz (Hz), of the resolution bandwidth (RBW) filter applied to the acquired signal. |
| GetRbwFilterBandwidthDefinition(string, out RFmxSpecAnMXSpectrumRbwFilterBandwidthDefinition) | Gets the bandwidth definition which you use to specify the value of the SetRbwFilterBandwidth(string, double) method. |
| GetRbwFilterType(string, out RFmxSpecAnMXSpectrumRbwFilterType) | Gets the shape of the digital resolution bandwidth (RBW) filter. |
| GetSequentialFftSize(string, out int) | Gets the FFT size when you set the SpectrumMeasurementMethod method to SequentialFft. If the method SpectrumRbwFilterAutoBandwidth is False, FFT Size is auto computed based on the configured SpectrumRbwFilterBandwidth |
| GetSpan(string, out double) | Gets the frequency range, in hertz (Hz), around the center frequency to be acquired for the measurement. |
| GetSweepTimeAuto(string, out RFmxSpecAnMXSpectrumSweepTimeAuto) | Gets whether the measurement computes the sweep time. |
| GetSweepTimeInterval(string, out double) | Gets the sweep time, in seconds. |
| GetVbwFilterAutoBandwidth(string, out RFmxSpecAnMXSpectrumVbwFilterAutoBandwidth) | Gets whether the video bandwidth (VBW) is expressed directly or computed based on the VBW to RBW ratio. |
| GetVbwFilterBandwidth(string, out double) | Gets the video bandwidth (VBW) in Hz when you set the SetVbwFilterAutoBandwidth(string, RFmxSpecAnMXSpectrumVbwFilterAutoBandwidth) method to False. |
| GetVbwFilterVbwToRbwRatio(string, out double) | Gets the VBW to RBW Ratio when you set the SetVbwFilterAutoBandwidth(string, RFmxSpecAnMXSpectrumVbwFilterAutoBandwidth) method to True . |
| SetAmplitudeCorrectionType(string, RFmxSpecAnMXSpectrumAmplitudeCorrectionType) | 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. |
| SetAnalysisInput(string, RFmxSpecAnMXSpectrumAnalysisInput) | Sets whether to analyze just the real I or Q component of the acquired IQ data, or analyze the complex IQ data. |
| SetAveragingCount(string, int) | Sets the number of acquisitions used for averaging when you set the SetAveragingEnabled(string, RFmxSpecAnMXSpectrumAveragingEnabled) method to True. |
| SetAveragingEnabled(string, RFmxSpecAnMXSpectrumAveragingEnabled) | Sets whether to enable averaging for the Spectrum measurement. |
| SetAveragingType(string, RFmxSpecAnMXSpectrumAveragingType) | Sets averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for Spectrum measurement. |
| SetDetectorPoints(string, int) | Sets the number of trace points after the detector is applied. |
| SetDetectorType(string, RFmxSpecAnMXSpectrumDetectorType) | Sets the type of detector to be used. |
| SetFftOverlap(string, double) | Sets the samples to overlap between the consecutive chunks as a percentage of the SpectrumSequentialFftSize method when you set the SpectrumMeasurementMethod method to SequentialFft and the SpectrumFftOverlapMode method to UserDefined. This value is expressed as a percentage. |
| SetFftOverlapMode(string, RFmxSpecAnMXSpectrumFftOverlapMode) | Sets the overlap mode when you set the SpectrumMeasurementMethod method to SequentialFft. |
| SetFftOverlapType(string, RFmxSpecAnMXSpectrumFftOverlapType) | Sets the overlap type when you set the SpectrumMeasurementMethod method to SequentialFft. |
| 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, RFmxSpecAnMXSpectrumFftWindow) | Sets the FFT window type used to reduce spectral leakage. |
| SetMeasurementEnabled(string, bool) | Sets whether to enable spectrum measurement. |
| SetMeasurementMethod(string, RFmxSpecAnMXSpectrumMeasurementMethod) | Sets the method for performing the Spectrum measurement. |
| SetMeasurementMode(string, RFmxSpecAnMXSpectrumMeasurementMode) | Sets whether the measurement calibrates the noise floor of analyzer or performs the spectrum measurement. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information. |
| SetNoiseCalibrationAveragingAuto(string, RFmxSpecAnMXSpectrumNoiseCalibrationAveragingAuto) | Sets whether RFmx automatically computes the averaging count used for instrument noise calibration. |
| SetNoiseCalibrationAveragingCount(string, int) | Sets the averaging count used for noise calibration when you set the SetNoiseCalibrationAveragingAuto(string, RFmxSpecAnMXSpectrumNoiseCalibrationAveragingAuto) method to False. |
| SetNoiseCalibrationMode(string, RFmxSpecAnMXSpectrumNoiseCalibrationMode) | Sets whether the noise calibration and measurement is performed manually by the user or automatically by RFmx. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information. |
| SetNoiseCompensationEnabled(string, RFmxSpecAnMXSpectrumNoiseCompensationEnabled) | Sets whether to enable compensation of the channel powers for the inherent noise floor of the signal analyzer. |
| SetNoiseCompensationType(string, RFmxSpecAnMXSpectrumNoiseCompensationType) | Sets the noise compensation type. Refer to the Noise Compensation Algorithm topic for more information. |
| SetNumberOfAnalysisThreads(string, int) | Sets the maximum number of threads used for parallelism for spectrum measurement. |
| SetPowerUnits(string, RFmxSpecAnMXSpectrumPowerUnits) | Sets the units for the absolute power. |
| SetRbwFilterAutoBandwidth(string, RFmxSpecAnMXSpectrumRbwAutoBandwidth) | Sets whether the resolution bandwidth (RBW) is computed by the measurement. |
| SetRbwFilterBandwidth(string, double) | Sets the bandwidth, in hertz (Hz), of the resolution bandwidth (RBW) filter applied to the acquired signal. |
| SetRbwFilterBandwidthDefinition(string, RFmxSpecAnMXSpectrumRbwFilterBandwidthDefinition) | Sets the bandwidth definition which you use to specify the value of the SetRbwFilterBandwidth(string, double) method. |
| SetRbwFilterType(string, RFmxSpecAnMXSpectrumRbwFilterType) | Sets the shape of the digital resolution bandwidth (RBW) filter. |
| SetSequentialFftSize(string, int) | Sets the FFT size when you set the SpectrumMeasurementMethod method to SequentialFft. If the method SpectrumRbwFilterAutoBandwidth is False, FFT Size is auto computed based on the configured SpectrumRbwFilterBandwidth |
| SetSpan(string, double) | Sets the frequency range, in hertz (Hz), around the center frequency to be acquired for the measurement. |
| SetSweepTimeAuto(string, RFmxSpecAnMXSpectrumSweepTimeAuto) | Sets whether the measurement computes the sweep time. |
| SetSweepTimeInterval(string, double) | Sets the sweep time, in seconds, when you set the SetSweepTimeAuto(string, RFmxSpecAnMXSpectrumSweepTimeAuto) method to False. |
| SetVbwFilterAutoBandwidth(string, RFmxSpecAnMXSpectrumVbwFilterAutoBandwidth) | Sets whether the video bandwidth (VBW) is expressed directly or computed based on the VBW to RBW ratio. |
| SetVbwFilterBandwidth(string, double) | Sets the video bandwidth (VBW) in Hz when you set the SetVbwFilterAutoBandwidth(string, RFmxSpecAnMXSpectrumVbwFilterAutoBandwidth) method to False. |
| SetVbwFilterVbwToRbwRatio(string, double) | Sets the VBW to RBW Ratio when you set the SetVbwFilterAutoBandwidth(string, RFmxSpecAnMXSpectrumVbwFilterAutoBandwidth) method to True . |
| ValidateNoiseCalibrationData(string, out RFmxSpecAnMXSpectrumNoiseCalibrationDataValid) | Indicates whether calibration data is valid for the configuration specified by the signal name in the selectorstring parameter. |