GetNoiseCompensationReferenceLevelCoercionLimit(string, out double)
- Updated2025-04-08
- 2 minute(s) read
Gets the coercion limit for the reference level for noise compensation. When you set the SetMeasurementMode(string, RFmxNRMXModAccMeasurementMode) method to Measure and SetNoiseCompensationEnabled(string, RFmxNRMXModAccNoiseCompensationEnabled) method to True, the measurement attempts to read noise floor calibration data corresponding to the configured reference level. If noise floor calibration data corresponding to the configured reference level is not found in the calibration database, the measurement attempts to read noise floor calibration data from the calibration database for any reference level in the range of the configured reference level plus or minus the coercion limit you set for this method.
Syntax
Namespace: NationalInstruments.RFmx.NRMX
public int GetNoiseCompensationReferenceLevelCoercionLimit(string selectorString, out double value)
Remarks
This method gets the value of ModAccNoiseCompensationReferenceLevelCoercionLimit attribute.For the configured reference level, if the noise calibration data is not present, the nearest value to the user-configured reference level that is available in the database within the coercion limit, is applied to the driver. The default value is 0.5.
Parameters
| Name | Type | Description |
|---|---|---|
| selectorString | string | Pass an empty string. The signal name that is passed when creating the signal configuration is used. |
| value | out double | Upon return, contains the coercion limit for the reference level for noise compensation. When you set the SetMeasurementMode(string, RFmxNRMXModAccMeasurementMode) method to Measure and SetNoiseCompensationEnabled(string, RFmxNRMXModAccNoiseCompensationEnabled) method to True, the measurement attempts to read noise floor calibration data corresponding to the configured reference level. If noise floor calibration data corresponding to the configured reference level is not found in the calibration database, the measurement attempts to read noise floor calibration data from the calibration database for any reference level in the range of the configured reference level plus or minus the coercion limit you set for this method. |
Returns
Returns the status code of this method. The status code either indicates success or describes a warning condition.