Gauss2D

class sherpa.models.basic.Gauss2D(name='gauss2d')[source] [edit on github]

Bases: sherpa.models.model.RegriddableModel2D

Two-dimensional gaussian function.

fwhm

The Full-Width Half Maximum of the gaussian along the major axis. It is related to the sigma value by: FWHM = sqrt(8 * log(2)) * sigma.

xpos

The center of the gaussian on the x0 axis.

ypos

The center of the gaussian on the x1 axis.

ellip

The ellipticity of the gaussian.

theta

The angle of the major axis. It is in radians, measured counter-clockwise from the X0 axis (i.e. the line X1=0).

ampl

The amplitude refers to the maximum peak of the model.

Notes

The functional form of the model for points is:

f(x0,x1) = ampl * exp(-4 * log(2) * r(x0,x1)^2)

r(x0,x1)^2 = xoff(x0,x1)^2 * (1-ellip)^2 + yoff(x0,x1)^2
             -------------------------------------------
                        fwhm^2 * (1-ellip)^2

xoff(x0,x1) = (x0 - xpos) * cos(theta) + (x1 - ypos) * sin(theta)

yoff(x0,x1) = (x1 - ypos) * cos(theta) - (x0 - xpos) * sin(theta)

The grid version is evaluated by adaptive multidimensional integration scheme on hypercubes using cubature rules, based on code from HIntLib (1) and GSL (2).

References

1

HIntLib - High-dimensional Integration Library http://mint.sbg.ac.at/HIntLib/

2

GSL - GNU Scientific Library http://www.gnu.org/software/gsl/

Attributes Summary

ndim

thawedparhardmaxes

thawedparhardmins

thawedparmaxes

thawedparmins

thawedpars

Methods Summary

apply(outer, *otherargs, **otherkwargs)

calc(*args, **kwargs)

Evaluate the model on a grid.

get_center()

guess(dep, *args, **kwargs)

Set an initial guess for the parameter values.

regrid(*args, **kwargs)

reset()

set_center(xpos, ypos, *args, **kwargs)

startup([cache])

Called before a model may be evaluated multiple times.

teardown()

Called after a model may be evaluated multiple times.

Attributes Documentation

ndim = 2
thawedparhardmaxes
thawedparhardmins
thawedparmaxes
thawedparmins
thawedpars

Methods Documentation

apply(outer, *otherargs, **otherkwargs) [edit on github]
calc(*args, **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()[source] [edit on github]
guess(dep, *args, **kwargs)[source] [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(*args, **kwargs) [edit on github]
reset() [edit on github]
set_center(xpos, ypos, *args, **kwargs)[source] [edit on github]
startup(cache=False) [edit on github]

Called before a model may be evaluated multiple times.

Parameters

cache (bool, optional) – Should a cache be used when evaluating the models.

See also

teardown()

teardown() [edit on github]

Called after a model may be evaluated multiple times.

See also

setup()