LorentzCurve Class

Represents a Lorentz peak curve that can be used for a non-linear regression calculation.

Definition

Namespace: Numerics.NET.Curves.Nonlinear
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.4
C# 
public class LorentzCurve : NonlinearCurve
Inheritance
Object  →  Curve  →  NonlinearCurve  →  LorentzCurve

Remarks

Use the GaussianCurve class to represent a four-parameter Lorentz curve. This curve is used to fit data that contains a peak. The peak is more pronounced than that of the Gaussian curve.

.

For details on how to fit a curve of this type, see the NonlinearCurveFitter class.

Constructors

LorentzCurve Constructs a new Lorentz curve.

Properties

Amplitude Gets or sets the width of the Lorentz curve.
Area Gets or sets the area of the Lorentz curve.
Center Gets or sets the center of the Lorentz curve.
Offset Gets or sets the offset of the Lorentz curve.
Parameters Gets the collection of parameters that determine the shape of this Curve.
(Inherited from Curve)
Width Gets or sets the width of the Lorentz curve.

Methods

Clone Constructs an exact copy of this instance.
(Inherited from Curve)
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FillNumericalPartialDerivatives Fills a dense vector with the partial derivatives of the curve with respect to each of the curve parameters computed using numerical differentiation.
(Inherited from NonlinearCurve)
FillPartialDerivatives Fills a dense vector with the partial derivatives of the curve with respect to each of the curve parameters.
(Overrides NonlinearCurve.FillPartialDerivatives(Double, DenseVector<Double>))
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
FindRoots Gets the set of X-coordinates where the curve crosses the X-axis.
(Inherited from Curve)
GetCurveFitter Returns a CurveFitter object that can be used to fit the curve to data.
(Inherited from NonlinearCurve)
GetDerivative Returns a Curve that represents the derivative of this Curve.
(Inherited from Curve)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetInitialFitParameters Returns a vector containing initial values for the parameters for a curve fit through on the specified data.
(Overrides NonlinearCurve.GetInitialFitParameters(Vector<Double>, Vector<Double>))
GetPartialDerivatives Returns a vector with the partial derivatives of the curve with respect to each of the curve parameters.
(Inherited from NonlinearCurve)
GetTypeGets the Type of the current instance.
(Inherited from Object)
Integral Gets the definite integral of the curve between the specified X-coordinates.
(Overrides Curve.Integral(Double, Double))
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
OnParameterChanged Called after a Curve parameter has been changed.
(Inherited from Curve)
OnParameterChanging Called before the value of a curve parameter is changed.
(Inherited from Curve)
SetParameter Sets a curve parameter to the specified value.
(Inherited from Curve)
SlopeAt Gets the slope of the curve at the specified X-coordinate.
(Overrides Curve.SlopeAt(Double))
Solve Finds the x value where the curve reaches the specified y value.
(Inherited from Curve)
TangentAt Gets the tangent line to the curve at the specified X-coordinate.
(Inherited from Curve)
ToStringReturns a string that represents the current object.
(Inherited from Object)
ValueAt Gets the Y-value of the curve at the specified X-coordinate.
(Overrides Curve.ValueAt(Double))

See Also