Click or drag to resize

PeakFittingByIncrementalPeakAddition Class

Fits peaks by incrementally adding peaks to a composite model until a stopping criterion is met.
Inheritance Hierarchy
SystemObject
  Altaxo.Science.Spectroscopy.PeakFittingPeakFittingByIncrementalPeakAddition

Namespace: Altaxo.Science.Spectroscopy.PeakFitting
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3448.0 (4.8.3448.0)
Syntax
C#
public class PeakFittingByIncrementalPeakAddition : IPeakFitting, 
	IEquatable<PeakFittingByIncrementalPeakAddition>

The PeakFittingByIncrementalPeakAddition type exposes the following members.

Constructors
 NameDescription
Public methodPeakFittingByIncrementalPeakAdditionInitializes a new instance of the PeakFittingByIncrementalPeakAddition class
Top
Properties
 NameDescription
Public propertyFitFunction Gets/sets the fit function to use.
Public propertyFitWidthScalingFactor Gets/sets the scaling factor of the fit width. When set, this value determines the width around a peak (as a multiple of the peak FWHM) that is used to calculate the parameter errors of that peak.
Public propertyIsMinimalFWHMValueInXUnits Gets a value indicating whether MinimalFWHMValue is specified in x-units.
Public propertyMaximumNumberOfPeaks Gets or sets the maximum number of peaks to add.
Public propertyMinimalFWHMValue Gets/sets the minimal allowed FWHM value.
Public propertyMinimalRelativeHeight Gets/sets the minimal relative height. The addition of new peaks is stopped if the fitting residual falls below this value.
Public propertyMinimalSignalToNoiseRatio Gets/sets the minimal signal-to-noise ratio. The addition of new peaks is stopped if the ratio of the highest remaining peak with respect to the noise level falls below this value.
Public propertyOrderOfBaselinePolynomial Gets or sets the order of the polynomial used for the baseline.
Public propertyPrunePeaksSumChiSquareFactor Gets/inits a factor used to prune peaks based on their contribution to the chi-square sum.
Top
Methods
 NameDescription
Public methodExecute(Double, Double, IEnumerablePeakDescription, CancellationToken) Fits peaks to the provided region by incrementally adding peaks.
Public methodExecute(Double, Double, Int32, IReadOnlyListValueTupleIReadOnlyListPeakDescription, Int32, Int32, CancellationToken) Executes the peak fitting algorithm.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodStatic memberPrunePeaksBasedOnSumChiSquare Prunes peaks based on the chi-square sum.
Top
See Also