RFmxSpecAnMXSpurConfiguration Class
- Updated2025-10-13
- 7 minute(s) read
Provides methods to configure the spurious emission (Spur) measurement.
Derives from
Syntax
Namespace: NationalInstruments.RFmx.SpecAnMX
public class RFmxSpecAnMXSpurConfiguration : 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, RFmxSpecAnMXSpurAveragingEnabled, int, RFmxSpecAnMXSpurAveragingType) | Configures averaging for the spurious emission (Spur) measurement. |
| ConfigureFftWindowType(string, RFmxSpecAnMXSpurFftWindow) | Configures the FFT window to obtain a spectrum for the spurious emission (Spur) measurement. |
| ConfigureNumberOfRanges(string, int) | Configures the number of ranges. |
| ConfigureRangeAbsoluteLimit(string, RFmxSpecAnMXSpurAbsoluteLimitMode, double, double) | Configures the absolute power limits corresponding to the beginning and end of the frequency range. |
| ConfigureRangeAbsoluteLimitArray(string, RFmxSpecAnMXSpurAbsoluteLimitMode[], double[], double[]) | Configures the absolute power limits corresponding to the beginning and end of the frequency range and specifies whether the absolute limit threshold is a flat line or a line with a slope. |
| ConfigureRangeDetector(string, RFmxSpecAnMXSpurRangeDetectorType, int) | Configures the detector settings including detector type and the number of points to be detected. |
| ConfigureRangeDetectorArray(string, RFmxSpecAnMXSpurRangeDetectorType[], int[]) | Configures an array of the detector settings including detector type and the number of points to be detected. |
| ConfigureRangeFrequency(string, double, double, RFmxSpecAnMXSpurRangeEnabled) | Configures the frequency start and stop values of the range. |
| ConfigureRangeFrequencyArray(string, double[], double[], RFmxSpecAnMXSpurRangeEnabled[]) | Configures the frequency start and stop values and specifies whether to enable measurement of the spurious emissions (Spur) in the frequency range. |
| ConfigureRangeNumberOfSpursToReport(string, int) | Configures the number of Spurs that the measurement should report in the frequency range. |
| ConfigureRangeNumberOfSpursToReportArray(string, int[]) | Configures the array of number of Spurs that the measurement should report in the frequency range. |
| ConfigureRangePeakCriteria(string, double, double) | Configures the peak threshold and peak excursion criteria which a peak should meet to be classified as a spurious emission (Spur). |
| ConfigureRangePeakCriteriaArray(string, double[], double[]) | Configures arrays of peak threshold and peak excursion criteria which a peak should meet to be classified as a spurious emission (Spur). |
| ConfigureRangeRbwArray(string, RFmxSpecAnMXSpurRbwAutoBandwidth[], double[], RFmxSpecAnMXSpurRbwFilterType[]) | Configures the resolution bandwidth (RBW) filter. |
| ConfigureRangeRbwFilter(string, RFmxSpecAnMXSpurRbwAutoBandwidth, double, RFmxSpecAnMXSpurRbwFilterType) | Configures the resolution bandwidth (RBW) filter. |
| ConfigureRangeRelativeAttenuation(string, double) | Configures the attenuation, in dB, relative to the external attenuation. Use this method to compensate for variations in external attenuation when the offset channels are spread wide in frequency. |
| ConfigureRangeRelativeAttenuationArray(string, double[]) | Configures an array of attenuation values, in dB, relative to the value of the GetExternalAttenuation(string, out double) method. Use this method to compensate for the variations in external attenuation when offset channels are spread wide in frequency. |
| ConfigureRangeSweepTime(string, RFmxSpecAnMXSpurSweepTimeAuto, double) | Configures the sweep time. |
| ConfigureRangeSweepTimeArray(string, RFmxSpecAnMXSpurSweepTimeAuto[], double[]) | Configures the array of sweep times, in seconds, when you set the SetRangeSweepTimeAuto(string, RFmxSpecAnMXSpurSweepTimeAuto) to False. |
| ConfigureRangeVbwFilter(string, RFmxSpecAnMXSpurRangeVbwFilterAutoBandwidth, double, double) | Configures the video bandwidth (VBW) settings including VBW Auto, VBW, and VBW to RBW ratio for the specified range. |
| ConfigureRangeVbwFilterArray(string, RFmxSpecAnMXSpurRangeVbwFilterAutoBandwidth[], double[], double[]) | Configures an array of the VBW settings, including VBW Auto, VBW, and VBW to RBW ratio for the specified range. |
| ConfigureTraceRangeIndex(string, int) | Configures the index of the range used to store and retrieve spurious emission (Spur) traces. When you set this method to -1, the measurement stores and retrieves traces for all enabled ranges. |
| GetAllTracesEnabled(string, out bool) | Gets whether the traces to be stored and retrieved after performing the spurious emissions (Spur) measurement are enabled. |
| GetAmplitudeCorrectionType(string, out RFmxSpecAnMXSpurAmplitudeCorrectionType) | 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 RFmxSpecAnMXSpurAveragingEnabled) | Gets whether averaging for the spurious emission (Spur) measurement is enabled. |
| GetAveragingType(string, out RFmxSpecAnMXSpurAveragingType) | Gets the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for spurious emission (Spur) measurement. |
| GetFftWindow(string, out RFmxSpecAnMXSpurFftWindow) | Gets the FFT window type used to reduce spectral leakage. |
| GetMeasurementEnabled(string, out bool) | Gets whether to enable spurious emission (Spur) measurement. |
| GetNumberOfAnalysisThreads(string, out int) | Gets the maximum number of threads used for parallelism for spurious emission (Spur) measurement. |
| GetNumberOfRanges(string, out int) | Gets the number of range configurations. |
| GetRangeAbsoluteLimitMode(string, out RFmxSpecAnMXSpurAbsoluteLimitMode) | Gets whether the absolute limit threshold is a flat line or a line with a slope. |
| GetRangeAbsoluteLimitStart(string, out double) | Gets the absolute power limit, in dBm, corresponding to the beginning of the frequency range. |
| GetRangeAbsoluteLimitStop(string, out double) | Gets the absolute power limit, in dBm, corresponding to the end of the frequency range. |
| GetRangeDetectorPoints(string, out int) | Gets the number of range points after the detector is applied. Use "range(n)" as the selector string to configure or read this method. |
| GetRangeDetectorType(string, out RFmxSpecAnMXSpurRangeDetectorType) | Gets the type of detector to be used. Use "range(n)" as the selector string to configure or read this method. |
| GetRangeEnabled(string, out RFmxSpecAnMXSpurRangeEnabled) | Gets whether the spurious emissions are measured in the frequency range. |
| GetRangeNumberOfSpursToReport(string, out int) | Gets the number of spurious emissions (Spur) that the measurement should report in the frequency range. |
| GetRangePeakExcursion(string, out double) | Gets the peak excursion value for finding the spurs on trace. The signal should rise and fall by at least the peak excursion value, above the threshold, to be considered as a spur. |
| GetRangePeakThreshold(string, out double) | Gets the threshold level, in dBm, above which the measurement detects spurs in the range that you specify using the SetRangeStartFrequency(string, double) and SetRangeStopFrequency(string, double) methods. |
| GetRangeRbwFilterAutoBandwidth(string, out RFmxSpecAnMXSpurRbwAutoBandwidth) | Gets whether the measurement computes the resolution bandwidth (RBW). |
| GetRangeRbwFilterBandwidth(string, out double) | Gets the bandwidth, in hertz (Hz), of the resolution bandwidth (RBW) filter applied to the acquired signal. |
| GetRangeRbwFilterBandwidthDefinition(string, out RFmxSpecAnMXSpurRbwFilterBandwidthDefinition) | Gets the bandwidth definition which you use to specify the value of the SetRangeRbwFilterBandwidth(string, double) method. |
| GetRangeRbwFilterType(string, out RFmxSpecAnMXSpurRbwFilterType) | Gets the shape of the digital resolution bandwidth (RBW) filter. |
| GetRangeRelativeAttenuation(string, out double) | Gets the attenuation, in dB, relative to the value of the SetExternalAttenuation(string, double) method. Use the attenuation to compensate for the variations in external attenuation when offset segments are spread wide in frequency. |
| GetRangeStartFrequency(string, out double) | Gets the start frequency of the frequency range, in hertz (Hz), for the measurement. |
| GetRangeStopFrequency(string, out double) | Gets the stop frequency of the frequency range, in hertz (Hz), for the measurement. |
| GetRangeSweepTimeAuto(string, out RFmxSpecAnMXSpurSweepTimeAuto) | Gets whether the measurement computes the sweep time. |
| GetRangeSweepTimeInterval(string, out double) | Gets the sweep time, in seconds. |
| GetRangeVbwFilterAutoBandwidth(string, out RFmxSpecAnMXSpurRangeVbwFilterAutoBandwidth) | Gets whether the video bandwidth (VBW) is expressed directly or computed based on the VBW to RBW ratio. |
| GetRangeVbwFilterBandwidth(string, out double) | Gets the video bandwidth (VBW) in Hz when you set the SetRangeVbwFilterAutoBandwidth(string, RFmxSpecAnMXSpurRangeVbwFilterAutoBandwidth) method to False. |
| GetRangeVbwFilterVbwToRbwRatio(string, out double) | Gets the VBW to RBW Ratio when you set the SetRangeVbwFilterAutoBandwidth(string, RFmxSpecAnMXSpurRangeVbwFilterAutoBandwidth) method to True. |
| GetTraceRangeIndex(string, out int) | Gets the index of the range used to store and retrieve spurious emission (Spur) traces. |
| SetAllTracesEnabled(string, bool) | Sets whether to enable the traces to be stored and retrieved after performing the spurious emissions (Spur) measurement. |
| SetAmplitudeCorrectionType(string, RFmxSpecAnMXSpurAmplitudeCorrectionType) | 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, RFmxSpecAnMXSpurAveragingEnabled) method to True. |
| SetAveragingEnabled(string, RFmxSpecAnMXSpurAveragingEnabled) | Sets whether to enable averaging for the spurious emission (Spur) measurement. |
| SetAveragingType(string, RFmxSpecAnMXSpurAveragingType) | Sets averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for spurious emission (Spur) measurement. |
| SetFftWindow(string, RFmxSpecAnMXSpurFftWindow) | Sets the FFT window type used to reduce spectral leakage. |
| SetMeasurementEnabled(string, bool) | Sets whether to enable spurious emission (Spur) measurement. |
| SetNumberOfAnalysisThreads(string, int) | Sets the maximum number of threads used for parallelism for spurious emission (Spur) measurement. |
| SetNumberOfRanges(string, int) | Sets the number of range configurations. |
| SetRangeAbsoluteLimitMode(string, RFmxSpecAnMXSpurAbsoluteLimitMode) | Sets whether the absolute limit threshold is a flat line or a line with a slope. |
| SetRangeAbsoluteLimitStart(string, double) | Sets the absolute power limit, in dBm, corresponding to the beginning of the frequency range. This power limit is also set as the absolute power limit for the range when you set the SetRangeAbsoluteLimitMode(string, RFmxSpecAnMXSpurAbsoluteLimitMode) to Couple. |
| SetRangeAbsoluteLimitStop(string, double) | Sets the absolute power limit, in dBm, corresponding to the end of the frequency range. This method is ignored when you set the SetRangeAbsoluteLimitMode(string, RFmxSpecAnMXSpurAbsoluteLimitMode) to Couple. |
| SetRangeDetectorPoints(string, int) | Sets the number of range points after the detector is applied. Use "range(n)" as the selector string to configure or read this method. |
| SetRangeDetectorType(string, RFmxSpecAnMXSpurRangeDetectorType) | Sets the type of detector to be used. Use "range(n)" as the selector string to configure or read this method. |
| SetRangeEnabled(string, RFmxSpecAnMXSpurRangeEnabled) | Sets whether to measure the spurious emissions (Spur) in the frequency range. |
| SetRangeNumberOfSpursToReport(string, int) | Sets the number of spurious emissions (Spur) that the measurement must report in the frequency range. |
| SetRangePeakExcursion(string, double) | Sets the peak excursion value for finding the spurs on the trace. The signal should rise and fall by at least the peak excursion value, above the threshold, to be considered as a spur. |
| SetRangePeakThreshold(string, double) | Sets the threshold level, in dBm, above which the measurement detects spurs in the range that you specify using the SetRangeStartFrequency(string, double) and SetRangeStopFrequency(string, double) methods. |
| SetRangeRbwFilterAutoBandwidth(string, RFmxSpecAnMXSpurRbwAutoBandwidth) | Sets whether the measurement computes the resolution bandwidth (RBW). |
| SetRangeRbwFilterBandwidth(string, double) | Sets the bandwidth, in hertz (Hz), of the resolution bandwidth (RBW) filter applied to the acquired signal. |
| SetRangeRbwFilterBandwidthDefinition(string, RFmxSpecAnMXSpurRbwFilterBandwidthDefinition) | Sets the bandwidth definition which you use to specify the value of the SetRangeRbwFilterBandwidth(string, double) method. |
| SetRangeRbwFilterType(string, RFmxSpecAnMXSpurRbwFilterType) | Sets the shape of the digital resolution bandwidth (RBW) filter. |
| SetRangeRelativeAttenuation(string, double) | Sets the attenuation, in dB, relative to the value which you set in the SetExternalAttenuation(string, double) method. Use the attenuation to compensate for the variations in external attenuation when offset segments are spread wide in frequency. |
| SetRangeStartFrequency(string, double) | Sets the start frequency of the frequency range, in hertz (Hz), for the measurement. |
| SetRangeStopFrequency(string, double) | Sets the stop frequency of the frequency range, in hertz (Hz), for the measurement. |
| SetRangeSweepTimeAuto(string, RFmxSpecAnMXSpurSweepTimeAuto) | Sets whether the measurement computes the sweep time. |
| SetRangeSweepTimeInterval(string, double) | Sets the sweep time, in seconds, when you set the SetRangeSweepTimeAuto(string, RFmxSpecAnMXSpurSweepTimeAuto) method to False. |
| SetRangeVbwFilterAutoBandwidth(string, RFmxSpecAnMXSpurRangeVbwFilterAutoBandwidth) | Sets whether the video bandwidth (VBW) is expressed directly or computed based on the VBW to RBW ratio. |
| SetRangeVbwFilterBandwidth(string, double) | Sets the video bandwidth (VBW) in Hz when you set the SetRangeVbwFilterAutoBandwidth(string, RFmxSpecAnMXSpurRangeVbwFilterAutoBandwidth) method to False. |
| SetRangeVbwFilterVbwToRbwRatio(string, double) | Sets the VBW to RBW Ratio when you set the SetRangeVbwFilterAutoBandwidth(string, RFmxSpecAnMXSpurRangeVbwFilterAutoBandwidth) method to True. |
| SetTraceRangeIndex(string, int) | Sets the index of the range used to store and retrieve spurious emission (Spur) traces. This method is not used if you set the spur all traces enabled to FALSE. When you set this method to -1, the measurement stores and retrieves traces for all enabled ranges. |