RFmx GSM DotNET

Table of Contents

RFmxGsmMX.GetReferenceLevelHeadroom Method

  • Updated2024-07-17
  • 1 minute(s) read
RFmxGsmMX.GetReferenceLevelHeadroom Method

RFmxGsmMXGetReferenceLevelHeadroom Method

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.


Namespace: NationalInstruments.RFmx.GsmMX
Assembly: NationalInstruments.RFmx.GsmMX.Fx40 (in NationalInstruments.RFmx.GsmMX.Fx40.dll) Version: 24.5.0.49286 (24.5.0.49286)

Syntax

public int GetReferenceLevelHeadroom(
	string selectorString,
	out double value
)
Public Function GetReferenceLevelHeadroom ( 
	selectorString As String,
	<OutAttribute> ByRef value As Double
) As Integer

Parameters

selectorString  String
Pass an empty string. The signal name that is passed when creating the signal configuration is used.
value  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.

Return Value

Int32
Returns the status code of this method. The status code either indicates success or describes a warning condition.

Remarks

This method gets the value of ReferenceLevelHeadroom attribute.

See Also

Log in to get a better experience