VoigtArea (FsODE)

FsODE

Documentation for 0.0.2

VoigtArea Type

Namespace: Altaxo.Calc.FitFunctions.Probability
Assembly: AltaxoCore.Redist.dll
Base Type: obj
All Interfaces: IFitFunctionPeak , IFitFunction , IImmutable

Fit fuction with one or more Voigt shaped peaks, with a background polynomial of variable order.

Constructors

Constructor	Description
`VoigtArea()` Full Usage: `VoigtArea()`
`VoigtArea(numberOfGaussianTerms, orderOfBackgroundPolynomial)` Full Usage: `VoigtArea(numberOfGaussianTerms, orderOfBackgroundPolynomial)` Parameters: numberOfGaussianTerms : `int` orderOfBackgroundPolynomial : `int`	numberOfGaussianTerms : `int` orderOfBackgroundPolynomial : `int`

Instance members

Instance member	Description
`this.Changed` Full Usage: `this.Changed` Returns: `IEvent<EventHandler, EventArgs>` Modifiers: abstract	Not functional because instance is immutable. Returns: `IEvent<EventHandler, EventArgs>`
`this.DefaultParameterValue` Full Usage: `this.DefaultParameterValue` Parameters: i : `int` Returns: `float` Modifiers: abstract	i : `int` Returns: `float`
`this.DefaultVarianceScaling` Full Usage: `this.DefaultVarianceScaling` Parameters: i : `int` Returns: `IVarianceScaling` Modifiers: abstract	i : `int` Returns: `IVarianceScaling`
`this.DependentVariableName` Full Usage: `this.DependentVariableName` Parameters: i : `int` Returns: `string` Modifiers: abstract	i : `int` Returns: `string`
`this.Evaluate` Full Usage: `this.Evaluate` Parameters: X : `float[]` P : `float[]` Y : `float[]` Modifiers: abstract	X : `float[]` P : `float[]` Y : `float[]`
`this.GetInitialParametersFromHeightPositionAndWidthAtRelativeHeight` Full Usage: `this.GetInitialParametersFromHeightPositionAndWidthAtRelativeHeight` Parameters: height : `float` position : `float` width : `float` relativeHeight : `float` Returns: `float[]` Modifiers: abstract	height : `float` position : `float` width : `float` relativeHeight : `float` Returns: `float[]`
`this.GetPositionAreaHeightFWHMFromSinglePeakParameters` Full Usage: `this.GetPositionAreaHeightFWHMFromSinglePeakParameters` Parameters: parameters : `float[]` Returns: `float * float * float * float` Modifiers: abstract	parameters : `float[]` Returns: `float * float * float * float`
`this.GetPositionAreaHeightFwhmFromSinglePeakParameters` Full Usage: `this.GetPositionAreaHeightFwhmFromSinglePeakParameters` Parameters: parameters : `float[]` cv : `IROMatrix<float>` Returns: `float * float * float * float * float * float * float * float` Modifiers: abstract	parameters : `float[]` cv : `IROMatrix<float>` Returns: `float * float * float * float * float * float * float * float`
`this.IndependentVariableName` Full Usage: `this.IndependentVariableName` Parameters: i : `int` Returns: `string` Modifiers: abstract	i : `int` Returns: `string`
`this.NumberOfDependentVariables` Full Usage: `this.NumberOfDependentVariables` Returns: `int` Modifiers: abstract	Returns: `int`
`this.NumberOfIndependentVariables` Full Usage: `this.NumberOfIndependentVariables` Returns: `int` Modifiers: abstract	Returns: `int`
`this.NumberOfParameters` Full Usage: `this.NumberOfParameters` Returns: `int` Modifiers: abstract	Returns: `int`
`this.NumberOfTerms` Full Usage: `this.NumberOfTerms` Returns: `int`	Gets the number of Voigt terms. Returns: `int`
`this.OrderOfBackgroundPolynomial` Full Usage: `this.OrderOfBackgroundPolynomial` Returns: `int`	Gets the order of the background polynomial. Returns: `int`
`this.ParameterName` Full Usage: `this.ParameterName` Parameters: i : `int` Returns: `string` Modifiers: abstract	i : `int` Returns: `string`
`this.ParameterNamesForOnePeak` Full Usage: `this.ParameterNamesForOnePeak` Returns: `string[]` Modifiers: abstract	Returns: `string[]`
`this.WithNumberOfTerms` Full Usage: `this.WithNumberOfTerms` Parameters: numberOfTerms : `int` - The number of Lorentzian (Cauchy) terms (should be greater than or equal to 1). Returns: `VoigtArea` New instance with the provided number of Lorentzian (Cauchy) terms.	Creates a new instance with the provided number of Lorentzian (Cauchy) terms. numberOfTerms : `int` The number of Lorentzian (Cauchy) terms (should be greater than or equal to 1). Returns: `VoigtArea` New instance with the provided number of Lorentzian (Cauchy) terms.
`this.WithOrderOfBackgroundPolynomial` Full Usage: `this.WithOrderOfBackgroundPolynomial` Parameters: orderOfBackgroundPolynomial : `int` - The order of the background polynomial. If set to -1, the background polynomial will be disabled. Returns: `VoigtArea` New instance with the background polynomial of the provided order.	Creates a new instance with the provided order of the background polynomial. orderOfBackgroundPolynomial : `int` The order of the background polynomial. If set to -1, the background polynomial will be disabled. Returns: `VoigtArea` New instance with the background polynomial of the provided order.

Static members

Static member	Description
`VoigtArea.Create_1_0()` Full Usage: `VoigtArea.Create_1_0()` Returns: `IFitFunction`	Returns: `IFitFunction`
`VoigtArea.Create_1_M1()` Full Usage: `VoigtArea.Create_1_M1()` Returns: `IFitFunction`	Returns: `IFitFunction`