Click or drag to resize

PearsonIVAmplitudeParametrizationHPW Class

Fit function with one or more PearsonIV shaped peaks, with a baseline polynomial of variable order. The PearsonIV is relocated and scaled in Height, Position and Width, so that the amplitude parameter is the maximum height of the peak, the position parameter is the x-value of the maximum, and the w parameter is approximately (38%) the half width half maximum (HWHM) of the peak.
Inheritance Hierarchy
SystemObject
  Altaxo.Calc.FitFunctions.PeaksPearsonIVAmplitudeParametrizationHPW

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

The PearsonIVAmplitudeParametrizationHPW type exposes the following members.

Constructors
 NameDescription
Public methodPearsonIVAmplitudeParametrizationHPW Initializes a new instance with one term and no baseline polynomial.
Public methodPearsonIVAmplitudeParametrizationHPW(Int32, Int32) Initializes a new instance with the specified number of 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_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 memberGetArea Gets the area under the peak.
Public methodStatic memberGetFWHM Gets the full width half maximum (FWHM)
Public methodStatic memberGetFWHMApproximation Gets an approximate value (19% error) for the full width half maximum
Public methodStatic memberGetHWHM Gets the half width half maximum of a given side of the peak.
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) 
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodStatic memberGetYOfOneTerm 
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
Remarks
See Also