RFmxSpecAnMXChpConfiguration Class
- Updated2025-10-13
- 6 minute(s) read
Provides methods to configure the channel power (CHP) measurement.
Derives from
Syntax
Namespace: NationalInstruments.RFmx.SpecAnMX
public class RFmxSpecAnMXChpConfiguration : 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, RFmxSpecAnMXChpAveragingEnabled, int, RFmxSpecAnMXChpAveragingType) | Configures averaging for the channel power (CHP) measurement. |
| ConfigureCarrierOffset(string, double) | Configures the center frequency of the carrier, relative to the RF center frequency. |
| ConfigureDetector(string, RFmxSpecAnMXChpDetectorType, int) | Configures the detector settings, including detector type and the number of points to be detected. |
| ConfigureFft(string, RFmxSpecAnMXChpFftWindow, double) | Configures window and FFT to obtain a spectrum for the channel power (CHP) measurement. |
| ConfigureIntegrationBandwidth(string, double) | Configures the frequency range, in hertz (Hz), over which the measurement integrates the carrier channel power. |
| ConfigureNumberOfCarriers(string, int) | Configures the number of carriers for the CHP measurement. |
| ConfigureRbwFilter(string, RFmxSpecAnMXChpRbwAutoBandwidth, double, RFmxSpecAnMXChpRbwFilterType) | Configures the resolution bandwidth (RBW) filter. |
| ConfigureRrcFilter(string, RFmxSpecAnMXChpCarrierRrcFilterEnabled, double) | Configures the root-raised-cosine (RRC) filter to apply on the channel before measuring the channel power. |
| ConfigureSpan(string, double) | Configures the frequency range, in hertz (Hz), around the center frequency, to acquire for the channel power (CHP) measurement. |
| ConfigureSweepTime(string, RFmxSpecAnMXChpSweepTimeAuto, double) | Configures the sweep time, in seconds, when you set the SetSweepTimeAuto(string, RFmxSpecAnMXChpSweepTimeAuto) method to False. |
| GetAllTracesEnabled(string, out bool) | Gets whether the traces to be stored and retrieved after performing the channel power (CHP) measurement are enabled. |
| GetAmplitudeCorrectionType(string, out RFmxSpecAnMXChpAmplitudeCorrectionType) | 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 RFmxSpecAnMXChpAveragingEnabled) | Indicates whether averaging for the channel power (CHP) measurement is enabled. |
| GetAveragingType(string, out RFmxSpecAnMXChpAveragingType) | Gets the averaging type for averaging multiple spectrum acquisitions. |
| GetCarrierFrequency(string, out double) | Gets the center frequency, in hertz (Hz), of the carrier, relative to the RF center frequency. |
| GetCarrierIntegrationBandwidth(string, out double) | Gets the frequency range, in hertz (Hz), over which the measurement integrates the power. |
| GetCarrierRrcFilterAlpha(string, out double) | Gets the roll-off factor for the root-raised-cosine (RRC) filter. |
| GetCarrierRrcFilterEnabled(string, out RFmxSpecAnMXChpCarrierRrcFilterEnabled) | Gets whether the root-raised-cosine (RRC) filter is applied on the acquired channel after measuring the channel power. |
| GetDetectorPoints(string, out int) | Gets the number of trace points after the detector is applied. |
| GetDetectorType(string, out RFmxSpecAnMXChpDetectorType) | Gets the type of detector to be used. |
| 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. |
| GetFftWindow(string, out RFmxSpecAnMXChpFftWindow) | Gets the FFT window type used to reduce spectral leakage. |
| GetIntegrationBandwidth(string, out double) | Gets the frequency range, in hertz (Hz), over which the measurement integrates the power. |
| GetMeasurementEnabled(string, out bool) | Gets whether the channel power (CHP) measurement is enabled. |
| GetMeasurementMode(string, out RFmxSpecAnMXChpMeasurementMode) | Gets whether the measurement calibrates the noise floor of analyzer or performs the CHP measurement. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information. |
| GetNoiseCalibrationAveragingAuto(string, out RFmxSpecAnMXChpNoiseCalibrationAveragingAuto) | 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, RFmxSpecAnMXChpNoiseCalibrationAveragingAuto) method to False. |
| GetNoiseCalibrationMode(string, out RFmxSpecAnMXChpNoiseCalibrationMode) | 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 RFmxSpecAnMXChpNoiseCompensationEnabled) | Gets whether RFmx compensates for the instrument noise when performing the measurement. To compensate for instrument noise when performing a CHP measurement, set the SetNoiseCalibrationMode(string, RFmxSpecAnMXChpNoiseCalibrationMode) method to Auto, or set the CHP Noise Cal Mode method to Manual and SetMeasurementMode(string, RFmxSpecAnMXChpMeasurementMode) method to Measure. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information. |
| GetNoiseCompensationType(string, out RFmxSpecAnMXChpNoiseCompensationType) | 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 channel power (CHP) measurement. |
| GetNumberOfCarriers(string, out int) | Gets the number of carriers. |
| GetRbwFilterAutoBandwidth(string, out RFmxSpecAnMXChpRbwAutoBandwidth) | 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 RFmxSpecAnMXChpRbwFilterBandwidthDefinition) | Gets the bandwidth definition which you use to specify the value of the SetRbwFilterBandwidth(string, double) method. |
| GetRbwFilterType(string, out RFmxSpecAnMXChpRbwFilterType) | Gets the shape of the digital resolution bandwidth (RBW) filter. |
| GetRrcFilterAlpha(string, out double) | Gets the roll-off factor for the root-raised-cosine (RRC) filter. |
| GetRrcFilterEnabled(string, out RFmxSpecAnMXChpRrcFilterEnabled) | Gets whether the root-raised-cosine (RRC) filter is applied on the acquired channel after measuring the channel power. |
| GetSpan(string, out double) | Gets the frequency range, in hertz (Hz), around the center frequency, to acquire for the measurement. |
| GetSweepTimeAuto(string, out RFmxSpecAnMXChpSweepTimeAuto) | 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 channel power (CHP) measurement. |
| SetAmplitudeCorrectionType(string, RFmxSpecAnMXChpAmplitudeCorrectionType) | 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, RFmxSpecAnMXChpAveragingEnabled) method to True. |
| SetAveragingEnabled(string, RFmxSpecAnMXChpAveragingEnabled) | Sets whether to enable averaging for the channel power (CHP) measurement. |
| SetAveragingType(string, RFmxSpecAnMXChpAveragingType) | Sets the averaging type for averaging multiple spectrum acquisitions. The averaged spectrum is used for channel power (CHP) measurement. |
| SetCarrierFrequency(string, double) | Sets the center frequency, in hertz (Hz), of the carrier, relative to the RF center frequency. |
| SetCarrierIntegrationBandwidth(string, double) | Sets the frequency range, in hertz (Hz), over which the measurement integrates the power. |
| SetCarrierRrcFilterAlpha(string, double) | Sets the roll-off factor for the root-raised-cosine (RRC) filter. |
| SetCarrierRrcFilterEnabled(string, RFmxSpecAnMXChpCarrierRrcFilterEnabled) | Sets whether to apply the root-raised-cosine (RRC) filter on the acquired channel after measuring the channel power. |
| SetDetectorPoints(string, int) | Sets the number of trace points after the detector is applied. |
| SetDetectorType(string, RFmxSpecAnMXChpDetectorType) | Sets the type of detector to be used. |
| 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, RFmxSpecAnMXChpFftWindow) | Sets the FFT window type used to reduce spectral leakage. |
| SetIntegrationBandwidth(string, double) | Sets the frequency range, in hertz (Hz), over which the measurement integrates the power. |
| SetMeasurementEnabled(string, bool) | Sets whether to enable the channel power (CHP) measurement. |
| SetMeasurementMode(string, RFmxSpecAnMXChpMeasurementMode) | Sets whether the measurement calibrates the noise floor of analyzer or performs the CHP measurement. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information. |
| SetNoiseCalibrationAveragingAuto(string, RFmxSpecAnMXChpNoiseCalibrationAveragingAuto) | 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, RFmxSpecAnMXChpNoiseCalibrationAveragingAuto) method to False. |
| SetNoiseCalibrationMode(string, RFmxSpecAnMXChpNoiseCalibrationMode) | 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, RFmxSpecAnMXChpNoiseCompensationEnabled) | Sets whether RFmx compensates for the instrument noise when performing the measurement. To compensate for instrument noise when performing a CHP measurement, set the SetNoiseCalibrationMode(string, RFmxSpecAnMXChpNoiseCalibrationMode) method to Auto, or set the CHP Noise Cal Mode method to Manual and SetMeasurementMode(string, RFmxSpecAnMXChpMeasurementMode) method to Measure. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information. |
| SetNoiseCompensationType(string, RFmxSpecAnMXChpNoiseCompensationType) | 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 channel power (CHP) measurement. |
| SetNumberOfCarriers(string, int) | Sets the number of carriers. |
| SetRbwFilterAutoBandwidth(string, RFmxSpecAnMXChpRbwAutoBandwidth) | 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, RFmxSpecAnMXChpRbwFilterBandwidthDefinition) | Sets the bandwidth definition which you use to specify the value of the SetRbwFilterBandwidth(string, double) method. |
| SetRbwFilterType(string, RFmxSpecAnMXChpRbwFilterType) | Sets the shape of the digital resolution bandwidth (RBW) filter. |
| SetRrcFilterAlpha(string, double) | Sets the roll-off factor for the root-raised-cosine (RRC) filter. |
| SetRrcFilterEnabled(string, RFmxSpecAnMXChpRrcFilterEnabled) | Sets whether to apply the root-raised-cosine (RRC) filter on the acquired channel after measuring the channel power. |
| SetSpan(string, double) | Sets the frequency range, in hertz (Hz), around the center frequency, to acquire for the measurement. |
| SetSweepTimeAuto(string, RFmxSpecAnMXChpSweepTimeAuto) | Sets whether the measurement computes the sweep time. |
| SetSweepTimeInterval(string, double) | Sets the sweep time, in seconds, when you set the SetSweepTimeAuto(string, RFmxSpecAnMXChpSweepTimeAuto) method to False. |
| ValidateNoiseCalibrationData(string, out RFmxSpecAnMXChpNoiseCalibrationDataValid) | Indicates whether calibration data is valid for the configuration specified by the signal name in the selectorstring parameter. |