Lorentz1D

class sherpa.astro.models.Lorentz1D(name='lorentz1d')

Bases: sherpa.models.model.RegriddableModel1D

One-dimensional normalized Lorentz model function.

fwhm

The full-width half maximum of the line.

pos

The center of the line.

ampl

The amplitude refers to the integral of the model.

See also

Beta1D, NormBeta1D

Notes

The functional form of the model for points is:

f(x) =                A * fwhm
       --------------------------------------
       2 * pi * (0.25 * fwhm^2 + (x - pos)^2)

   A = ampl / integral f(x) dx

and for an integrated grid it is the integral of this over the bin.

Attributes Summary

thawedparhardmaxes
thawedparhardmins
thawedparmaxes
thawedparmins
thawedpars

Methods Summary

apply(outer, *otherargs, **otherkwargs)
calc(pars, xlo, *args, **kwargs)
get_center()
guess(dep, *args, **kwargs)	Set an initial guess for the parameter values.
regrid(*arrays)
reset()
set_center(pos, *args, **kwargs)
startup()	Called before a model may be evaluated multiple times.
teardown()	Called after a model may be evaluated multiple times.

Attributes Documentation

thawedparhardmaxes

thawedparhardmins

thawedparmaxes

thawedparmins

thawedpars

Methods Documentation

apply(outer, *otherargs, **otherkwargs)

calc(pars, xlo, *args, **kwargs)

get_center()

guess(dep, *args, **kwargs)

Set an initial guess for the parameter values.

Attempt to set the parameter values, and ranges, for the model to match the data values. This is intended as a rough guess, so it is expected that the model is only evaluated a small number of times, if at all.

regrid(*arrays)

reset()

set_center(pos, *args, **kwargs)

startup()

Called before a model may be evaluated multiple times.

See also

teardown()

teardown()

Called after a model may be evaluated multiple times.

See also

setup()