RFmxLteMXChpConfiguration.GetNoiseCompensationEnabled Method
- Updated2024-07-17
- 1 minute(s) read
RFmxLteMXChpConfigurationGetNoiseCompensationEnabled Method
Gets whether the RFmx driver compensates for the instrument noise when performing the measurement. To compensate for instrument noise when performing a CHP measurement, set the SetNoiseCalibrationMode(String, RFmxLteMXChpNoiseCalibrationMode) method to Auto, or set the CHP Noise Cal Mode method to Manual and the SetMeasurementMode(String, RFmxLteMXChpMeasurementMode) method to Measure. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.
Namespace: NationalInstruments.RFmx.LteMX
Assembly: NationalInstruments.RFmx.LteMX.Fx40 (in NationalInstruments.RFmx.LteMX.Fx40.dll) Version: 24.5.0.49283 (24.5.0.49283)
Syntax
public int GetNoiseCompensationEnabled( string selectorString, out RFmxLteMXChpNoiseCompensationEnabled value )
Public Function GetNoiseCompensationEnabled ( selectorString As String, <OutAttribute> ByRef value As RFmxLteMXChpNoiseCompensationEnabled ) As Integer
Parameters
- selectorString
- Type: SystemString
Pass an empty string. The signal name that is passed when creating the signal configuration is used. - value
- Type: NationalInstruments.RFmx.LteMXRFmxLteMXChpNoiseCompensationEnabled
Upon return, contains whether the RFmx driver compensates for the instrument noise when performing the measurement. To compensate for instrument noise when performing a CHP measurement, set the SetNoiseCalibrationMode(String, RFmxLteMXChpNoiseCalibrationMode) method to Auto, or set the CHP Noise Cal Mode method to Manual and the SetMeasurementMode(String, RFmxLteMXChpMeasurementMode) method to Measure. Refer to the measurement guidelines section in the Noise Compensation Algorithm topic for more information.
Return Value
Type: Int32Returns the status code of this method. The status code either indicates success or describes a warning condition.
Remarks
This method gets the value of ChpNoiseCompensationEnabled attribute. The default value is False.