Click or drag to resize

CauchyAmplitude Class

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

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

The CauchyAmplitude type exposes the following members.

Constructors
 NameDescription
Public methodCauchyAmplitudeInitializes a new instance of the CauchyAmplitude class
Public methodCauchyAmplitude(Int32, Int32)Initializes a new instance of the CauchyAmplitude 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.
Public propertyParameterNamesForOnePeak Gets the parameter names for one peak.
Top
Methods
 NameDescription
Public methodStatic memberCreate_1_0 
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 methodGetInitialParametersFromHeightPositionAndWidthAtRelativeHeight 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.
Public methodGetParameterBoundariesForPositivePeaks Gets the parameter boundaries in order to have positive peaks only.
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 methodGetPositionAreaHeightFWHMFromSinglePeakParameters(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.
Public methodGetPositionAreaHeightFWHMFromSinglePeakParameters(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).
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