Click or drag to resize

GaussAmplitude Class

Fit fuction with one or more gaussian shaped peaks (bell shape), with a baseline polynomial of variable order.
Inheritance Hierarchy
SystemObject
  Altaxo.Calc.FitFunctions.PeaksGaussAmplitude

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

The GaussAmplitude type exposes the following members.

Constructors
 NameDescription
Public methodGaussAmplitude Initializes a new instance with one Gaussian term and no baseline polynomial.
Public methodGaussAmplitude(Int32, Int32) Initializes a new instance with the specified number of Gaussian terms and baseline order.
Top
Properties
 NameDescription
Public propertyNumberOfDependentVariables Number of dependent variables (i.e. y, in Altaxo this is commonly called v (like value)).
Public propertyNumberOfIndependentVariables Number of independent variables (i.e. x).
Public propertyNumberOfParameters Number of parameters of this fit function.
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 methodStatic memberCreate_1_M1 
Public methodDefaultParameterValue Returns a default parameter value. You must ensure that the fit function would generate values with those default parameters.
Public methodDefaultVarianceScaling Returns the default variance scaling for the dependent variable i.
Public methodDependentVariableName Returns the ith dependent variable name.
Public methodEvaluate(Double, Double, Double) This evaluates a function value.
Public methodEvaluate(IROMatrixDouble, IReadOnlyListDouble, IVectorDouble, IReadOnlyListBoolean) Evaluates the function values at multiple x-points.
Public methodEvaluateDerivative Evaluates the gradient of the function with respect to the parameters.
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 methodStatic memberGetFWHMFromWidthAndRelativeHeight Gets the FWHM from the width value and the relative height at which the width was determined.
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 methodStatic memberGetYOfOneTerm Gets the value of a single Gaussian term for the provided parameters.
Public methodIndependentVariableName Returns the ith independent variable name.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodParameterName Returns the ith parameter name.
Public methodToStringReturns a string that represents the current object.
(Overrides ObjectToString)
Top
Events
 NameDescription
Public eventChanged Not functional because instance is immutable.
Top
Fields
 NameDescription
Public fieldStatic memberNumberOfParametersPerPeak 
Top
See Also