GetReferenceLevelHeadroom(string, out double)
- Updated2025-10-13
- 1 minute(s) read
Gets the margin RFmx adds to the Reference Level method. The margin avoids clipping and overflow warnings if the input signal exceeds the configured reference level. RFmx configures the input gain to avoid clipping and associated overflow warnings provided the instantaneous power of the input signal remains within the reference level plus the reference level headroom. If you know the input power of the signal precisely or previously included the margin in the reference level, you could improve the signal-to-noise ratio by reducing the reference level headroom. Default values
PXIe-5668: 6 dB
PXIe-5830/5831/5832/5841/5842/5860: 1 dB
PXIe-5840: 0 dB Supported devices: PXIe-5668R, PXIe-5830/5831/5832/5840/5841/5842/5860.
Syntax
Namespace: NationalInstruments.RFmx.Cdma2kMX
public int GetReferenceLevelHeadroom(string selectorString, out double value)
Remarks
This method gets the value of ReferenceLevelHeadroom attribute.
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 margin RFmx adds to the Reference Level method. The margin avoids clipping and overflow warnings if the input signal exceeds the configured reference level. |
Returns
Returns the status code of this method. The status code either indicates success or describes a warning condition.