Keysight Pathwave 89600 VSA .NET API
TopPeaks Method
See Also 
Agilent.SA.Vsa.Interfaces Assembly > Agilent.SA.Vsa Namespace > MarkerCollection Class : TopPeaks Method


peakOrder
Order of returned peaks, either by ascending X-values or by descending Y-values.
maximumPeakCount
Maximum # of peaks to return (no limit if maximumPeakCount <= 0).

Glossary Item Box

Returns a list (pairs of x- and y-values) of all the peaks.

Syntax

Visual Basic (Declaration) 
Public Overridable Function TopPeaks( _
   ByVal peakOrder As MarkersPeakOrder, _
   ByVal maximumPeakCount As Integer _
) As Double()
C# 
public virtual double[] TopPeaks( 
   MarkersPeakOrder peakOrder,
   int maximumPeakCount
)
C++/CLI 
public:
virtual array<double>^ TopPeaks( 
   MarkersPeakOrder peakOrder,
   int maximumPeakCount
)

Parameters

peakOrder
Order of returned peaks, either by ascending X-values or by descending Y-values.
maximumPeakCount
Maximum # of peaks to return (no limit if maximumPeakCount <= 0).

Return Value

Returns an array of x- and y-values, one for each peak. If no peaks are found, then an empty array is returned

Requirements

Target Platforms: Windows 11 Professional or Enterprise; Windows 10 Professional, Enterprise, or Education (64-bit)

Minimum Software Version Requirement: Keysight PathWave 89600 VSA Ver 18.50

See Also