Cauchy |
Fit function with one or more Lorentzian shaped peaks (bell shape), with a baseline polynomial
of variable order. In case you need the probability density function of the Cauchy distribution,
the equivalent fit function in the Probability namespace is better suited.
Inheritance HierarchyNamespace: Altaxo.Calc.FitFunctions.Peaks
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3448.0 (4.8.3448.0)
SyntaxC#
public class CauchyAmplitude : IFitFunctionWithDerivative, IFitFunction, IFitFunctionPeak, IImmutable, IEquatable<CauchyAmplitude>
The CauchyAmplitude type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CauchyAmplitude | Initializes a new instance with one term and no baseline polynomial. |
| CauchyAmplitude(Int32, Int32) | Initializes a new instance with the specified number of terms and baseline polynomial order. |
Properties| Name | Description | |
|---|---|---|
 | 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. |
| NumberOfTerms | Gets/sets the number of peak terms. |
| OrderOfBaselinePolynomial | Gets/sets the order of the baseline polynomial. |
| ParameterNamesForOnePeak | Gets the parameter names for one peak. |
Methods| Name | Description | |
|---|---|---|
 | Create_1_0 | Factory used by discovery to create a default instance (one term, zero-order baseline). |
| 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) |
| IndependentVariableName | Returns the ith independent variable name. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| ParameterName | Returns the ith parameter name. |
| ToString | Returns a string that represents the current object. (Overrides ObjectToString) |
Events
RemarksSee Also