Lorentz1D¶
-
class
astropy.modeling.functional_models.
Lorentz1D
[source] [edit on github]¶ Bases:
astropy.modeling.Fittable1DModel
One dimensional Lorentzian model.
Parameters: amplitude : float
Peak value
x_0 : float
Position of the peak
fwhm : float
Full width at half maximum
Other Parameters: fixed : a dict
A dictionary
{parameter_name: boolean}
of parameters to not be varied during fitting. True means the parameter is held fixed. Alternatively thefixed
property of a parameter may be used.tied : dict
A dictionary
{parameter_name: callable}
of parameters which are linked to some other parameter. The dictionary values are callables providing the linking relationship. Alternatively thetied
property of a parameter may be used.bounds : dict
eqcons : list
A list of functions of length
n
such thateqcons[j](x0,*args) == 0.0
in a successfully optimized problem.ineqcons : list
A list of functions of length
n
such thatieqcons[j](x0,*args) >= 0.0
is a successfully optimized problem.See also
Notes
Model formula:
\[f(x) = \frac{A \gamma^{2}}{\gamma^{2} + \left(x - x_{0}\right)^{2}}\]Attributes Summary
amplitude
fwhm
param_names
x_0
Methods Summary
evaluate
(x, amplitude, x_0, fwhm)One dimensional Lorentzian model function fit_deriv
(x, amplitude, x_0, fwhm)One dimensional Lorentzian model derivative with respect to parameters Attributes Documentation
-
amplitude
¶
-
fwhm
¶
-
param_names
= ('amplitude', 'x_0', 'fwhm')¶
-
x_0
¶
Methods Documentation
-
static
evaluate
(x, amplitude, x_0, fwhm)[source] [edit on github]¶ One dimensional Lorentzian model function
-
static
fit_deriv
(x, amplitude, x_0, fwhm)[source] [edit on github]¶ One dimensional Lorentzian model derivative with respect to parameters
-