IFit |
[Missing <summary> documentation for "T:Altaxo.Calc.FitFunctions.Peaks.IFitFunctionPeak"]
Namespace: Altaxo.Calc.FitFunctions.Peaks
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3179.0 (4.8.3179.0)
SyntaxC#
public interface IFitFunctionPeak : IFitFunction
The IFitFunctionPeak type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | NumberOfDependentVariables |
Number of dependent variables (i.e. y, in Altaxo this is commonly called v (like value)).
(Inherited from IFitFunction) |
| NumberOfIndependentVariables |
Number of independent variables (i.e. x).
(Inherited from IFitFunction) |
| NumberOfParameters |
Number of parameters of this fit function.
(Inherited from IFitFunction) |
| NumberOfTerms | Gets the number of terms. |
| OrderOfBaselinePolynomial | Gets the order of the polynomial that is used for the baseline. A value of -1 disables the baseline. |
| ParameterNamesForOnePeak | Gets the parameter names for one peak. |
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 IFitFunction) |
| DefaultVarianceScaling |
Returns the default variance scaling for the dependent variable i.
(Inherited from IFitFunction) |
| DependentVariableName |
Returns the ith dependent variable name.
(Inherited from IFitFunction) |
| Evaluate(Double, Double, Double) |
This evaluates a function value.
(Inherited from IFitFunction) |
| Evaluate(IROMatrixDouble, IReadOnlyListDouble, IVectorDouble, IReadOnlyListBoolean) |
Evaluates the function values at multiple x-points.
(Inherited from IFitFunction) |
| 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.
(Inherited from IFitFunction) |
| 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 IFitFunction) |
| 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). |
| IndependentVariableName |
Returns the ith independent variable name.
(Inherited from IFitFunction) |
| ParameterName |
Returns the ith parameter name.
(Inherited from IFitFunction) |
| WithNumberOfTerms | Creates a new fit function with the provided number of terms (peaks). |
| WithOrderOfBaselinePolynomial | Creates a new fit function with the provided order of the baseline polynomial. A value of -1 disables the baseline. |
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 IFitFunction) |
See Also