Retains
CopyC#
Extrema
 in
CopyC#
this
 instance that satisfy the
CopyC#
FilterDelegate
, simultaneously for each Extrema, FilterDelegate(extrema[i-1], extrema[i], extrema[i+1]). This allows the filtering of extrema based on the two immediate neighbors. End-point extrema can be dropped at will based on boolean
CopyC#
DropEdgePeaks
.

Namespace:  CenterSpace.NMath.Core
Assembly:  NMath (in NMath.dll) Version: 5.1.0.0

Syntax

C#
public void RetainPeaks(
	Func<Extrema, Extrema, Extrema, bool> FilterDelegate,
	bool DropEdgePeaks
)
Visual Basic (Declaration)
Public Sub RetainPeaks ( _
	FilterDelegate As Func(Of Extrema, Extrema, Extrema, Boolean), _
	DropEdgePeaks As Boolean _
)
Visual C++
public:
void RetainPeaks(
	Func<Extrema, Extrema, Extrema, bool>^ FilterDelegate, 
	bool DropEdgePeaks
)

Parameters

FilterDelegate
Type: System..::.Func<(Of <(Extrema, Extrema, Extrema, Boolean>)>)
The filter delegate
DropEdgePeaks
Type: System..::.Boolean
If true, the first and last peaks are also removed.

Return Value

A list of Extrema that satisified the delegate (returned true).

Remarks

Note that in the filtering process, all peaks are retained until the filtering is completed. The end-point extrema can be dropped at will since they can't be tested against the filtering delegate.

See Also