Click or drag to resize

PeakFinderBase Class

Abstract base class for all peak finding algorithms. The class is an enumerable collection of all found peaks.
Inheritance Hierarchy

Namespace:  CenterSpace.NMath.Core
Assembly:  NMath (in NMath.dll) Version: 7.3
Syntax
[SerializableAttribute]
public abstract class PeakFinderBase

The PeakFinderBase type exposes the following members.

Constructors
  NameDescription
Protected methodPeakFinderBase
Builds an instance of the abstract peak finding base class.
Top
Properties
  NameDescription
Public propertyInputData
Gets / Sets the input data. Set nullifies current peak list.
Public propertyItem
Gets the extrema via index operator.
Public propertyNumberPeaks
Gets the number of peaks found.
Top
Methods
  NameDescription
Public methodApplySortOrder
Applies the desired sort order on the found peaks.
Public methodGetAllPeaks
Returns a list of all
Extrema
found.
Public methodLocatePeakIndices
Locates the Indices in the vector preceeding the peak.
Public methodLocatePeaks
Locates the all peak abscissae and their smoothed values in current data set.
Public methodRetainPeaks(FuncExtrema, Boolean)
Retains
Extrema
in
this
instance that don't satisfy the
FilterDelegate
.
Public methodRetainPeaks(FuncExtrema, Extrema, Extrema, Boolean, Boolean)
Retains
Extrema
in
this
instance that satisfy the
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
DropEdgePeaks
.
Public methodSelectPeaks Obsolete.
Deprecated. Selects and returns a list of
Extrema
e that satisfy the
FilterDelegate
.
Public methodSelectPeaksForwardOrder
Selects and returns a list of
Extrema
e that satisfy the
FilterDelegate
.
Public methodSelectPeaksReverseOrder
Selects and returns a list of
Extrema
e that satisfy the
FilterDelegate
.
Top
Fields
  NameDescription
Protected fieldpeakabscissae_
List of the peaks abscissae.
Protected fieldpeakvalues_
List of peaks ordinates.
Top
See Also