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

C++

Copy

public class PeakFinderRuleBased : PeakFinderBase, 
	ICloneable

Public Class PeakFinderRuleBased
	Inherits PeakFinderBase
	Implements ICloneable

public ref class PeakFinderRuleBased : public PeakFinderBase, 
	ICloneable

type PeakFinderRuleBased = 
    class
        inherit PeakFinderBase
        interface ICloneable
    end

The PeakFinderRuleBased type exposes the following members.

Constructors

	Name	Description
	PeakFinderRuleBased	An instance of a rule based naive peak finder.

Top

Properties

	Name	Description
	AbscissaInterval	Gets\Sets the abscissa interval for the data.
	InputData	Gets / Sets the input data. Set nullifies current peak list. (Inherited from PeakFinderBase)
	Item	Gets the extrema via index operator. (Inherited from PeakFinderBase)
	NumberPeaks	Gets the number of peaks found.

Top

Methods

	Name	Description
	AddRule	Apply a peak filtering rule.
	ApplySortOrder	Applies the desired sort order on the found peaks. (Inherited from PeakFinderBase)
	Clone	Creates a deep copy of this PeakFinderRuleBased instance.
	GetAllPeaks	Returns a list of all C# Copy Extrema found. (Inherited from PeakFinderBase)
	LocatePeakIndices	Locates the indices in the vector of the peaks. (Overrides PeakFinderBaseLocatePeakIndices)
	LocatePeaks	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)
	RemoveRule	Removes a peak filtering rule.
	RetainPeaks(FuncExtrema, Boolean)	Retains C# Copy Extrema in C# Copy this instance that don't satisfy the C# Copy FilterDelegate . (Inherited from PeakFinderBase)
	RetainPeaks(FuncExtrema, Extrema, Extrema, Boolean, Boolean)	Retains C# Copy Extrema in C# Copy this instance that satisfy the C# Copy 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# Copy DropEdgePeaks . (Inherited from PeakFinderBase)
	SelectPeaks	Obsolete. Deprecated. Selects and returns a list of C# Copy Extrema e that satisfy the C# Copy FilterDelegate . (Inherited from PeakFinderBase)
	SelectPeaksForwardOrder	Selects and returns a list of C# Copy Extrema e that satisfy the C# Copy FilterDelegate . (Inherited from PeakFinderBase)
	SelectPeaksReverseOrder	Selects and returns a list of C# Copy Extrema e that satisfy the C# Copy FilterDelegate . (Inherited from PeakFinderBase)

Top

Fields

	Name	Description
	peakabscissae_	List of the peaks abscissae. (Inherited from PeakFinderBase)
	peakvalues_	List of peaks ordinates. (Inherited from PeakFinderBase)

Top

Remarks

This class largely mimics MATLAB's Findpeaks function.

Reference

CenterSpace.NMath.Core Namespace