Cauchy |
Fit fuction with one or more Lorentzian shaped peaks (bell shape), with a background polynomial
of variable order. In the special case, in which the area is 1 and the background polynomial zero,
this equals to the probability density function of the Cauchy distribution.
Inheritance HierarchyNamespace: Altaxo.Calc.FitFunctions.Probability
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3448.0 (4.8.3448.0)
SyntaxC#
public class CauchyArea : IFitFunctionWithDerivative, IFitFunction, IImmutable, IEquatable<CauchyArea>
The CauchyArea type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CauchyArea | Initializes a new instance of the CauchyArea class |
| CauchyArea(Int32, Int32) | Initializes a new instance of the CauchyArea class |
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. |
Methods| Name | Description | |
|---|---|---|
 | Create_1_0 | |
| Create_1_M1 | |
| 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) |
| GetParameterBoundariesForPositivePeaks | |
| 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. |
| 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