Interpolated |
Base class for peak functions whose shape is defined by a two-dimensional lookup table
and evaluated by interpolation.
Inheritance HierarchySystemObject
Altaxo.Calc.FitFunctions.PeaksInterpolatedPeakFunctionFromMatrix
Altaxo.Calc.FitFunctions.PeaksInterpolatedPeakFunctionFrom2DTable
Altaxo.Calc.FitFunctions.PeaksInterpolatedPeakFunctionFromMatrix
Altaxo.Calc.FitFunctions.PeaksInterpolatedPeakFunctionFrom2DTable
Namespace: Altaxo.Calc.FitFunctions.Peaks
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3572.0 (4.8.3572.0)
SyntaxC#
public class InterpolatedPeakFunctionFromMatrix : IFitFunctionWithDerivative, IFitFunction, IFitFunctionPeak, IImmutable, IEquatable<InterpolatedPeakFunctionFromMatrix>
The InterpolatedPeakFunctionFromMatrix type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | InterpolatedPeakFunctionFromMatrix(Int32, Int32, Boolean) | Initializes a new instance of the InterpolatedPeakFunctionFromMatrix class. |
 | InterpolatedPeakFunctionFromMatrix(Int32, Int32, IReadOnlyListDouble, Boolean, IReadOnlyListDouble, IROMatrixDouble) | Initializes a new instance of the InterpolatedPeakFunctionFromMatrix class. |
Properties| Name | Description | |
|---|---|---|
 | AreaSpline | Gets the interpolation function used to calculate area values. |
| FwhmSpline | Gets the interpolation function used to calculate full width at half maximum (FWHM) values. |
| MaximalPositionOrWidth | Gets the maximal peak position that can be evaluated. |
| MaximalX | Gets the maximal x value that can be evaluated. |
| MinimalPositionOrWidth | Gets the minimal peak position that can be evaluated. |
| MinimalX | Gets the minimal x value that can be evaluated. |
 | NumberOfDependentVariables | Number of dependent variables (i.e. y, in Altaxo this is commonly called v (like value)). |
| NumberOfIndependentVariables | Number of independent variables (i.e. x). |
| NumberOfParameters | Number of parameters of this fit function. |
| NumberOfParametersPerPeak | Gets the number of parameters per peak. |
| NumberOfTerms | Gets the number of peak terms. |
| OrderOfBaselinePolynomial | Gets the order of the baseline polynomial. |
| ParameterNamesForOnePeak | Gets the parameter names for one peak. |
| PropertyIsPeakWidth | Gets a value indicating whether the additional peak property represents the peak width. |
| Spline | Gets the spline used to interpolate the lookup table. |
Methods| Name | Description | |
|---|---|---|
| DefaultParameterValue | Returns a default parameter value. You must ensure that the fit function would generate values with those default parameters. |
| DefaultVarianceScaling | Returns the default variance scaling for the dependent variable i. |
| DependentVariableName | Returns the ith dependent variable name. |
| Evaluate(Double, Double, Double) | This evaluates a function value. |
| Evaluate(IROMatrixDouble, IReadOnlyListDouble, IVectorDouble, IReadOnlyListBoolean) | Evaluates the function values at multiple x-points. |
| EvaluateDerivative | Evaluates the gradient of the function with respect to the parameters. |
| 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. |
| GetParameterBoundariesForPositivePeaks | Gets the parameter boundaries in order to have positive peaks only. |
| 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. |
| 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. |
| 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. |
| 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). |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| GetYOfOneTerm_PropertyIsPosition | Evaluates one peak term from the table interpolation. |
| GetYOfOneTerm_PropertyIsWidth | Evaluates one peak term from the table interpolation. |
| IndependentVariableName | Returns the ith independent variable name. |
| Initialize | Initializes the component, setting up necessary resources and configurations. |
| InitializeSpline | Initializes the spline from a matrix representation of peak curves. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| ParameterName | Returns the ith parameter name. |
Events| Name | Description | |
|---|---|---|
 | Changed | Occurs when the fit function changed, including number or name of parameters, independent variables, dependent variables, or the scaling. |
Remarks
The lookup table is interpreted as a function z = z(x, y) given on a regular grid.
Interpolation is performed using BivariateAkimaSpline.
See Also