Click or drag to resize

PeakFinderRuleBased Class

Class PeakFinderRuleBased simply returns all of the peaks subject to rules about peak height and peak separation. A peak is defined as a point which is higher that both neighbors or infinity. Non-infinity end points are excluded as a peak.
Inheritance Hierarchy
SystemObject
  CenterSpace.NMath.CorePeakFinderBase
    CenterSpace.NMath.CorePeakFinderRuleBased

Namespace: CenterSpace.NMath.Core
Assembly: NMath (in NMath.dll) Version: 7.4
Syntax
public class PeakFinderRuleBased : PeakFinderBase, 
	ICloneable

The PeakFinderRuleBased type exposes the following members.

Constructors
 NameDescription
Public methodPeakFinderRuleBased An instance of a rule based naive peak finder.
Top
Properties
 NameDescription
Public propertyAbscissaInterval Gets\Sets the abscissa interval for the data.
Public propertyInputData Gets / Sets the input data. Set nullifies current peak list.
(Inherited from PeakFinderBase)
Public propertyItem Gets the extrema via index operator.
(Inherited from PeakFinderBase)
Public propertyNumberPeaks Gets the number of peaks found.
Top
Methods
 NameDescription
Public methodAddRule Apply a peak filtering rule.
Public methodApplySortOrder Applies the desired sort order on the found peaks.
(Inherited from PeakFinderBase)
Public methodClone Creates a deep copy of this PeakFinderRuleBased instance.
Public methodGetAllPeaks Returns a list of all
C#
Extrema
found.
(Inherited from PeakFinderBase)
Public methodLocatePeakIndices Locates the indices in the vector of the peaks.
(Overrides PeakFinderBaseLocatePeakIndices)
Public methodLocatePeaks Locates the all peak abscissae and their ordinates in current data set. THe peaks are reported in the order found in the dataset.
(Overrides PeakFinderBaseLocatePeaks)
Public methodRemoveRule Removes a peak filtering rule.
Public methodRetainPeaks(FuncExtrema, Boolean) Retains
C#
Extrema
in
C#
this
instance that don't satisfy the
C#
FilterDelegate
.
(Inherited from PeakFinderBase)
Public methodRetainPeaks(FuncExtrema, Extrema, Extrema, Boolean, Boolean) Retains
C#
Extrema
in
C#
this
instance that satisfy the
C#
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
C#
DropEdgePeaks
.
(Inherited from PeakFinderBase)
Public methodSelectPeaksObsolete.
Deprecated. Selects and returns a list of
C#
Extrema
e that satisfy the
C#
FilterDelegate
.
(Inherited from PeakFinderBase)
Public methodSelectPeaksForwardOrder Selects and returns a list of
C#
Extrema
e that satisfy the
C#
FilterDelegate
.
(Inherited from PeakFinderBase)
Public methodSelectPeaksReverseOrder Selects and returns a list of
C#
Extrema
e that satisfy the
C#
FilterDelegate
.
(Inherited from PeakFinderBase)
Top
Fields
 NameDescription
Protected fieldpeakabscissae_ List of the peaks abscissae.
(Inherited from PeakFinderBase)
Protected fieldpeakvalues_ List of peaks ordinates.
(Inherited from PeakFinderBase)
Top
Remarks
This class largely mimics MATLAB's Findpeaks function.
See Also