RFmxSpecAnMXChpConfiguration.SetNoiseCompensationEnabled Method
- Updated2024-07-17
- 1 minute(s) read
RFmx
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.
Namespace: NationalInstruments.RFmx.SpecAnMX
Assembly: NationalInstruments.RFmx.SpecAnMX.Fx40 (in NationalInstruments.RFmx.SpecAnMX.Fx40.dll) Version: 24.5.0.49286 (24.5.0.49286)
Syntax
public int SetNoiseCompensationEnabled( string selectorString, RFmxSpecAnMXChpNoiseCompensationEnabled value )
Public Function SetNoiseCompensationEnabled ( selectorString As String, value As RFmxSpecAnMXChpNoiseCompensationEnabled ) As Integer
Parameters
- selectorString String
- Pass an empty string. The signal name that is passed when creating the signal configuration is used.
- value RFmxSpecAnMXChpNoiseCompensationEnabled
- Specifies 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.
Return Value
Int32Returns the status code of this method. The status code either indicates success or describes a warning condition.
Remarks
This method sets the value of ChpNoiseCompensationEnabled attribute.The default value is False.