Click or drag to resize

SNIP_Base Class

Base type for SNIP (Statistics-sensitive Non-linear Iterative Procedure) baseline estimation methods.
Inheritance Hierarchy

Namespace: Altaxo.Science.Spectroscopy.BaselineEstimation
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3572.0 (4.8.3572.0)
Syntax
C#
Copy
public abstract class SNIP_Base : IEquatable<SNIP_Base>

The SNIP_Base type exposes the following members.

Constructors
 NameDescription
Protected methodSNIP_BaseInitializes a new instance of the SNIP_Base class
Top
Properties
 NameDescription
Public propertyHalfWidth Gets half of the width of the averaging window.
Public propertyIsHalfWidthInXUnits Gets a value indicating whether HalfWidth is specified in x-axis units.
Public propertyNumberOfRegularIterations Gets the number of regular iterations. The default is 40.
Top
Methods
 NameDescription
Public methodStatic memberCalculateHalfWidthInPointsLocallyRoundDown Given the half width in x-axis units, calculates the half width in points (to the left and right) for every point in x.
Public methodStatic memberCalculateHalfWidthInPointsLocallyRoundUp Given the half width in x-axis units, calculates the half width in points (to the left and right) for every point in x.
Protected methodEvaluateBaselineWithConstantHalfWidth Executes the algorithm to estimate the baseline for the provided spectrum. This method is specialized for (almost) equally spaced x-values; thus the half width can be given in points.
Protected methodEvaluateBaselineWithLocalHalfWidth Executes the algorithm using a locally calculated half width. This method is specialized for non-uniformly spaced x-values and a half width specified in x-units. The half width in points is calculated individually for each point.
Public methodExecute(Double, Double, Int32) Executes the baseline estimation algorithm for the provided spectrum and returns the detrended result.
Public methodExecute(ReadOnlySpanDouble, ReadOnlySpanDouble, SpanDouble) Executes the algorithm for the provided spectrum and writes the estimated baseline into resultingBaseline.
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 methodStatic memberGetStatisticsOfInterPointDistance Gets the statistics of the absolute distance between two subsequent points in the provided array.
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Top
Fields
 NameDescription
Protected field_halfWidth Stores the configured half-width of the averaging window.
Protected field_isHalfWidthInXUnits Stores whether _halfWidth is expressed in x-axis units.
Protected field_numberOfRegularStages Stores the configured number of regular SNIP iterations.
Protected fieldStatic member_roundUp Indicates whether half-width values are rounded upward when converting to point counts.
Protected fieldStatic membersqrt2 Square root of two.
Top
See Also