EmissionLorentz¶

class sherpa.astro.optical.EmissionLorentz(name='emissionlorentz')[source]¶

Bases: sherpa.models.model.ArithmeticModel

Lorentz function for modeling emission.

It is for use when the independent axis is in Angstroms.

fwhm¶: The full-width half-maximum of the model in km/s.

pos¶: The center of the lorentzian, in Angstroms.

flux¶: The normalisation of the lorentzian.

kurt¶: The kurtosis of the lorentzian.

Notes

The functional form of the model for points is:

f(x) = flux * 2 * pi * s / l(x)

l(x) = abs(x - pos)^kurt + (0.5 * s)^2

s = pos * fwhm / c

c = speed of light in km/s

and for integrated data sets the low-edge of the grid is used.

The speed of light can be found by inspecting the module variable sherpa.astro.optical.c_km.

Attributes Summary

`thawedparhardmaxes`
`thawedparhardmins`
`thawedparmaxes`
`thawedparmins`
`thawedpars`

Methods Summary

`apply`(outer, \otherargs, \\*otherkwargs)
`calc`(p, x[, xhi])
`get_center`()
`guess`(dep, \args, \\*kwargs)	Set an initial guess for the parameter values.
`reset`()
`set_center`(\args, \\*kwargs)
`startup`()
`teardown`()

Attributes Documentation

thawedparhardmaxes¶

thawedparhardmins¶

thawedparmaxes¶

thawedparmins¶

thawedpars¶

Methods Documentation

apply(outer, *otherargs, **otherkwargs)¶

calc(p, x, xhi=None, **kwargs)[source]¶

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.

reset()¶

set_center(*args, **kwargs)¶

startup()¶

teardown()¶