Click or drag to resize

CauchyArea Class

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 Hierarchy
SystemObject
  Altaxo.Calc.FitFunctions.ProbabilityCauchyArea

Namespace: Altaxo.Calc.FitFunctions.Probability
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3179.0 (4.8.3179.0)
Syntax
C#
public class CauchyArea : IFitFunctionWithDerivative, IFitFunction, 
	IImmutable, IEquatable<CauchyArea>

The CauchyArea type exposes the following members.

Constructors
 NameDescription
Public methodCauchyAreaInitializes a new instance of the CauchyArea class
Public methodCauchyArea(Int32, Int32)Initializes a new instance of the CauchyArea class
Top
Properties
 NameDescription
Public propertyNumberOfDependentVariables 
Public propertyNumberOfIndependentVariables 
Public propertyNumberOfParameters 
Public propertyNumberOfTerms Gets/sets the number of peak terms.
Public propertyOrderOfBaselinePolynomial Gets/sets the order of the baseline polynomial.
Top
Methods
 NameDescription
Public methodStatic memberCreate_1_0 
Public methodStatic memberCreate_1_M1 
Public methodDefaultParameterValue 
Public methodDefaultVarianceScaling 
Public methodDependentVariableName 
Public methodEvaluate(Double, Double, Double) 
Public methodEvaluate(IROMatrixDouble, IReadOnlyListDouble, IVectorDouble, IReadOnlyListBoolean) 
Public methodEvaluateDerivative 
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetParameterBoundariesForPositivePeaks 
Public methodGetParameterBoundariesHardLimit 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.
Public methodGetParameterBoundariesSoftLimit 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.
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodIndependentVariableName 
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodParameterName 
Public methodToStringReturns a string that represents the current object.
(Overrides ObjectToString)
Top
Events
 NameDescription
Public eventChanged Not functional because instance is immutable.
Top
Remarks
See Also