AbsorptionEdge

class sherpa.astro.optical.AbsorptionEdge(name='absorptionedge')[source] [edit on github]

Bases: sherpa.models.model.RegriddableModel1D

Optical model of an absorption edge.

This model is intended to be used to modify another model (e.g. by multiplying the two together). It is for use when the independent axis is in wavelength units (e.g. Angstrom).

egdew

The location of the edge. Above this value the model is set to 1.

tau

The optical depth of the edge.

index

The exponent used for the relative distance from the edge. It is a hidden parameter, with a value fixed at 3.

Notes

The functional form of the model for points is:

f(x) = exp(-tau * (x / edgew)^index)   for x <= edgew

     = 1                               otherwise

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

Attributes Summary

thawedparhardmaxes
thawedparhardmins
thawedparmaxes
thawedparmins
thawedpars

Methods Summary

apply(outer, *otherargs, **otherkwargs)
calc(p, x[, xhi]) Evaluate the model on a grid.
get_center()
guess(dep, *args, **kwargs) Set an initial guess for the parameter values.
regrid(*arrays)
reset()
set_center(*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) [edit on github]
calc(p, x, xhi=None, **kwargs)[source] [edit on github]

Evaluate the model on a grid.

Parameters:
  • p (sequence of numbers) – The parameter values to use. The order matches the pars field.
  • *args – The model grid. The values can be scalar or arrays, and the number depends on the dimensionality of the model and whether it is being evaluated over an integrated grid or at a point (or points).
get_center() [edit on github]
guess(dep, *args, **kwargs) [edit on github]

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) [edit on github]
reset() [edit on github]
set_center(*args, **kwargs) [edit on github]
startup() [edit on github]

Called before a model may be evaluated multiple times.

See also

teardown()

teardown() [edit on github]

Called after a model may be evaluated multiple times.

See also

setup()