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.4

Syntax

[SerializableAttribute]
public abstract class PeakFinderBase

<SerializableAttribute>
Public MustInherit Class PeakFinderBase

[SerializableAttribute]
public ref class PeakFinderBase abstract

[<AbstractClassAttribute>]
[<SerializableAttribute>]
type PeakFinderBase = class end

The PeakFinderBase type exposes the following members.

Constructors

	Name	Description
	PeakFinderBase	Builds an instance of the abstract peak finding base class.

Properties

	Name	Description
	InputData	Gets / Sets the input data. Set nullifies current peak list.
	Item	Gets the extrema via index operator.
	NumberPeaks	Gets the number of peaks found.

Methods

	Name	Description
	ApplySortOrder	Applies the desired sort order on the found peaks.
	GetAllPeaks	Returns a list of all C# Copy Extrema found.
	LocatePeakIndices	Locates the Indices in the vector preceeding the peak.
	LocatePeaks	Locates the all peak abscissae and their smoothed values in current data set.
	RetainPeaks(FuncExtrema, Boolean)	Retains C# Copy Extrema in C# Copy this instance that don't satisfy the C# Copy FilterDelegate .
	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 .
	SelectPeaks	Obsolete. Deprecated. Selects and returns a list of C# Copy Extrema e that satisfy the C# Copy FilterDelegate .
	SelectPeaksForwardOrder	Selects and returns a list of C# Copy Extrema e that satisfy the C# Copy FilterDelegate .
	SelectPeaksReverseOrder	Selects and returns a list of C# Copy Extrema e that satisfy the C# Copy FilterDelegate .

Fields

	Name	Description
	peakabscissae_	List of the peaks abscissae.
	peakvalues_	List of peaks ordinates.