Click or drag to resize

ArPLS Class

Implements the asymmetrically reweighted penalized least squares algorithm proposed by Baek et al. [1].
Inheritance Hierarchy

Namespace: Altaxo.Science.Spectroscopy.BaselineEstimation
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3448.0 (4.8.3448.0)
Syntax
C#
Copy
public class ArPLS : ArPLSBase, IBaselineEstimation, 
	ISingleSpectrumPreprocessor, IEquatable<ArPLS>

The ArPLS type exposes the following members.

Constructors
 NameDescription
Public methodArPLSInitializes a new instance of the ArPLS class
Top
Properties
 NameDescription
Public propertyLambda Gets the smoothing parameter lambda. The higher lambda is, the smoother the resulting curve will be.
(Inherited from ArPLSBase)
Public propertyMaximumNumberOfIterations Gets the maximum number of iterations. The default value is 100. Usually, the number of iterations is determined by TerminationRatio, but with this value the maximum number of iterations can be limited.
(Inherited from ArPLSBase)
Public propertyOrder Gets the order of the difference penalty.
(Inherited from ArPLSBase)
Public propertyScaleLambdaWithXUnits Gets a value indicating whether Lambda is scaled with the x-units, so that the effect of baseline estimation is independent of the resolution of the spectrum.
(Inherited from ArPLSBase)
Public propertyTerminationRatio Gets the criterion for terminating the iteration (0..1). The default is 0.05. The iteration stops if the L2 norm of the differences between the actual and the previous weights falls below (TerminationRatio × L2 norm of the previous weights). The lower the value is, the more iterations will be executed.
(Inherited from ArPLSBase)
Top
Methods
 NameDescription
Public methodExecute(Double, Double, Int32)
(Inherited from ALSMethodsBase)
Public methodExecute(ReadOnlySpanDouble, ReadOnlySpanDouble, SpanDouble)
(Inherited from ArPLSBase)
Public methodFillBandMatrixOrder1 Fills a tridiagonal band matrix for a first-order difference penalty.
(Inherited from ALSMethodsBase)
Public methodFillBandMatrixOrder2 Fills a pentadiagonal band matrix for a second-order difference penalty.
(Inherited from ALSMethodsBase)
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 methodUpdateBandMatrixDiagonalOrder1 Updates only the diagonal of a tridiagonal band matrix for a first-order difference penalty.
(Inherited from ALSMethodsBase)
Public methodUpdateBandMatrixDiagonalOrder2 Updates only the diagonal of a pentadiagonal band matrix for a second-order difference penalty.
(Inherited from ALSMethodsBase)
Top
Remarks

References:

[1] Sung-June Baek et al., Baseline correction using asymmetrically reweighted penalized least squares smoothing, Analyst, 2015, 140, 250-257 doi: 10.1039/C4AN01061B

See Also