Lorentz1D

class astropy.modeling.functional_models.Lorentz1D(amplitude, x_0, fwhm, **constraints)

Bases: astropy.modeling.core.Parametric1DModel

One dimensional Lorentzian model.

Parameters:

amplitude : float

Peak value

x_0 : float

Position of the peak

fwhm : float

Full width at half maximum

See also

Gaussian1D, Box1D, MexicanHat1D

Notes

Model formula:

f(x) = \frac{A \gamma^{2}}{\gamma^{2} + \left(x - x_{0}\right)^{2}}

fixed: a dict

a dictionary {parameter_name: boolean} of parameters to not be varied during fitting. True means the parameter is held fixed. Alternatively the fixed 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 the tied property of a parameter may be used.

bounds: dict

a dictionary {parameter_name: boolean} of lower and upper bounds of parameters. Keys are parameter names. Values are a list of length 2 giving the desired range for the parameter. Alternatively the min and max properties of a parameter may be used.

eqcons: list

A list of functions of length n such that eqcons[j](x0,*args) == 0.0 in a successfully optimized problem.

ineqcons : list

A list of functions of length n such that ieqcons[j](x0,*args) >= 0.0 is a successfully optimized problem.

Attributes Summary

amplitude
fwhm
param_names	list() -> new empty list
x_0

Methods Summary

deriv(x, amplitude, x_0, fwhm)	One dimensional Lorentzian model derivative
eval(x, amplitude, x_0, fwhm)	One dimensional Lorentzian model function

Attributes Documentation

amplitude

fwhm

param_names = ['amplitude', 'x_0', 'fwhm']

x_0

Methods Documentation

static deriv(x, amplitude, x_0, fwhm)

One dimensional Lorentzian model derivative

static eval(x, amplitude, x_0, fwhm)

One dimensional Lorentzian model function