Gets the signal frequency relative to the RF center frequency. Only samples above the threshold are used when you set the SetThresholdEnabled(string, RFmxSpecAnMXFcntThresholdEnabled) method to True.

Syntax

Namespace: NationalInstruments.RFmx.SpecAnMX

public int GetAverageRelativeFrequency(string selectorString, out double value)

Remarks

This method maps to the RFmxSpecAn_FCntGetResultsAverageRelativeFrequency() function in C.

Parameters

NameTypeDescription
selectorStringstring

Specifies the result name. Example: "", "result::r1". You can use the BuildResultString(string) method to build the selector string.

valueout double

Upon return, contains the signal frequency relative to the RF center frequency. Only samples above the threshold are used when you set the SetThresholdEnabled(string, RFmxSpecAnMXFcntThresholdEnabled) method to True.

Returns

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