InterpolatedPeakFunctionFrom2DTable Class

Peak function whose shape is defined by a two-dimensional lookup table stored in a DataTable.

Inheritance Hierarchy

SystemObject
Altaxo.Calc.FitFunctions.PeaksInterpolatedPeakFunctionFromMatrix
Altaxo.Calc.FitFunctions.PeaksInterpolatedPeakFunctionFrom2DTable

Namespace: Altaxo.Calc.FitFunctions.Peaks
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3572.0 (4.8.3572.0)

Syntax

Copy

public class InterpolatedPeakFunctionFrom2DTable : InterpolatedPeakFunctionFromMatrix, 
	IEquatable<InterpolatedPeakFunctionFrom2DTable>

The InterpolatedPeakFunctionFrom2DTable type exposes the following members.

Constructors

	Name	Description
	InterpolatedPeakFunctionFrom2DTable	Initializes a new default instance of the InterpolatedPeakFunctionFrom2DTable class.
	InterpolatedPeakFunctionFrom2DTable(Int32, Int32, DataTable, Int32, String, Boolean)	Initializes a new instance of the InterpolatedPeakFunctionFrom2DTable class.
	InterpolatedPeakFunctionFrom2DTable(Int32, Int32, String, Int32, String, Boolean)	Initializes a new instance of the InterpolatedPeakFunctionFrom2DTable class.

Top

Properties

	Name	Description
	AreaSpline	Gets the interpolation function used to calculate area values. (Inherited from InterpolatedPeakFunctionFromMatrix)
	FwhmSpline	Gets the interpolation function used to calculate full width at half maximum (FWHM) values. (Inherited from InterpolatedPeakFunctionFromMatrix)
	GroupNumberOfParticipatingColumns	Gets the column group number used to select the participating columns within the table.
	MaximalPositionOrWidth	Gets the maximal peak position that can be evaluated. (Inherited from InterpolatedPeakFunctionFromMatrix)
	MaximalX	Gets the maximal x value that can be evaluated. (Inherited from InterpolatedPeakFunctionFromMatrix)
	MinimalPositionOrWidth	Gets the minimal peak position that can be evaluated. (Inherited from InterpolatedPeakFunctionFromMatrix)
	MinimalX	Gets the minimal x value that can be evaluated. (Inherited from InterpolatedPeakFunctionFromMatrix)
	NameOfPropertyForPeakPositionOrWidth	Gets the name of the property column that stores the peak position values or peak width value for each participating column. The exact meaning depends on the value of PropertyIsPeakWidth: if true, the property column is expected to store peak width values; if false, the property column is expected to store peak position values.
	NumberOfDependentVariables	Number of dependent variables (i.e. y, in Altaxo this is commonly called v (like value)). (Inherited from InterpolatedPeakFunctionFromMatrix)
	NumberOfIndependentVariables	Number of independent variables (i.e. x). (Inherited from InterpolatedPeakFunctionFromMatrix)
	NumberOfParameters	Number of parameters of this fit function. (Inherited from InterpolatedPeakFunctionFromMatrix)
	NumberOfParametersPerPeak	Gets the number of parameters per peak. (Inherited from InterpolatedPeakFunctionFromMatrix)
	NumberOfTerms	Gets the number of peak terms. (Inherited from InterpolatedPeakFunctionFromMatrix)
	OrderOfBaselinePolynomial	Gets the order of the baseline polynomial. (Inherited from InterpolatedPeakFunctionFromMatrix)
	ParameterNamesForOnePeak	Gets the parameter names for one peak. (Inherited from InterpolatedPeakFunctionFromMatrix)
	PropertyIsPeakWidth	Gets a value indicating whether the additional peak property represents the peak width. (Inherited from InterpolatedPeakFunctionFromMatrix)
	Spline	Gets the spline used to interpolate the lookup table. (Inherited from InterpolatedPeakFunctionFromMatrix)
	TableName	Gets the name of the data table that contains the peak curves and any associated metadata.

Top

Methods

	Name	Description
	DefaultParameterValue	Returns a default parameter value. You must ensure that the fit function would generate values with those default parameters. (Inherited from InterpolatedPeakFunctionFromMatrix)
	DefaultVarianceScaling	Returns the default variance scaling for the dependent variable i. (Inherited from InterpolatedPeakFunctionFromMatrix)
	DependentVariableName	Returns the ith dependent variable name. (Inherited from InterpolatedPeakFunctionFromMatrix)
	Evaluate(Double, Double, Double)	This evaluates a function value. (Inherited from InterpolatedPeakFunctionFromMatrix)
	Evaluate(IROMatrixDouble, IReadOnlyListDouble, IVectorDouble, IReadOnlyListBoolean)	Evaluates the function values at multiple x-points. (Inherited from InterpolatedPeakFunctionFromMatrix)
	EvaluateDerivative	Evaluates the gradient of the function with respect to the parameters. (Inherited from InterpolatedPeakFunctionFromMatrix)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetInitialParametersFromHeightPositionAndWidthAtRelativeHeight	Gets the initial parameters for one term (peak) by providing the height of the peak, the position of the peak, the width of the peak, and the relative height at which the width was measured. (Inherited from InterpolatedPeakFunctionFromMatrix)
	GetParameterBoundariesForPositivePeaks	Gets the parameter boundaries in order to have positive peaks only. (Inherited from InterpolatedPeakFunctionFromMatrix)
	GetParameterBoundariesHardLimit	Gets the parameter boundaries that are really a hard limit, i.e. outside those limits, the function would probably evaluate NaN values, or makes no sense. (Inherited from InterpolatedPeakFunctionFromMatrix)
	GetParameterBoundariesSoftLimit	Gets the intended parameter boundaries. This are soft limits, boundaries so that the intended purpose of the fit function is fullfilled. Example: in the exponential decay Exp(-a*t) a is intended to be positive. This is a soft limit, and not a hard limit, because a could be also negative, and the fit nevertheless would succeed. (Inherited from InterpolatedPeakFunctionFromMatrix)
	GetPositionAreaHeightFWHMFromSinglePeakParameters(IReadOnlyListDouble)	Gets the position, the area under the peak, the height, and the Full Width Half Maximum (FWHM) from the parameters of a single peak. (Inherited from InterpolatedPeakFunctionFromMatrix)
	GetPositionAreaHeightFWHMFromSinglePeakParameters(IReadOnlyListDouble, IROMatrixDouble)	Gets the position, the area under the peak, the height, and the Full Width Half Maximum (FWHM) from the parameters of a single peak. If the covariance matrix is given, then also the standard deviations of position, area, height, FWHM are calculated (otherwise, zero values are returned for the standard deviations). (Inherited from InterpolatedPeakFunctionFromMatrix)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	GetYOfOneTerm_PropertyIsPosition	Evaluates one peak term from the table interpolation. (Inherited from InterpolatedPeakFunctionFromMatrix)
	GetYOfOneTerm_PropertyIsWidth	Evaluates one peak term from the table interpolation. (Inherited from InterpolatedPeakFunctionFromMatrix)
	IndependentVariableName	Returns the ith independent variable name. (Inherited from InterpolatedPeakFunctionFromMatrix)
	Initialize	Initializes the component, setting up necessary resources and configurations. (Overrides InterpolatedPeakFunctionFromMatrixInitialize)
	Initialize(DataTable)	Initializes the internal state using data from the specified table, extracting relevant columns and preparing data for spline processing.
	InitializeSpline	Initializes the spline from a matrix representation of peak curves. (Inherited from InterpolatedPeakFunctionFromMatrix)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ParameterName	Returns the ith parameter name. (Inherited from InterpolatedPeakFunctionFromMatrix)

Top

Events

	Name	Description
	Changed	Occurs when the fit function changed, including number or name of parameters, independent variables, dependent variables, or the scaling. (Inherited from InterpolatedPeakFunctionFromMatrix)

Top

Remarks

The table is expected to contain multiple DoubleColumn instances (the participating columns) that represent peak curves. The x values are taken from the corresponding x column, and the peak position values are taken from a property column. The resulting matrix is then interpolated using the base implementation.

Reference

Altaxo.Calc.FitFunctions.Peaks Namespace