RFmx SpecAn DOTNET

RFmxSpecAnMXSpectrumResults.GetPeakFrequency Method

  • Updated2024-07-17
  • 1 minute(s) read
RFmxSpecAnMXSpectrumResults.GetPeakFrequency Method

RFmxSpecAnMXSpectrumResultsGetPeakFrequency Method

Gets the frequency, in hertz (Hz), at the peak amplitude of the averaged spectrum.

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

Syntax

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

Parameters

selectorString  String
Specifies the result name. Example: "", "result::r1". You can use the BuildResultString(String) method to build the selector string.
value  Double
Upon return, contains the frequency, in Hz, at the peak amplitude of the averaged spectrum.

Return Value

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

Remarks

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

See Also