Box2D

class sherpa.models.basic.Box2D(name='box2d')[source] [edit on github]

Bases: RegriddableModel2D

Two-dimensional box function.

The model is flat between the limits, where it is set to the ampl parameter. Outside this range the model is zero.

xlow: The lower edge of the box (x0 axis).

xhi: The upper edge of the box (x0 axis).

ylow: The lower edge of the box (x1 axis).

yhi: The upper edge of the box (x1 axis).

ampl: The amplitude of the box.

See also

Box1D, Const2D, Delta2D

Notes

The functional form of the model for points is:

f(x0,x1) = ampl if xlow <= x0 <= xhi
                   ylow <= x1 <= yhi
         = 0       otherwise

and for an integrated grid it is:

f(x0lo,x0hi,x1lo,x1hi)
         = 0            if x0hi <= xlow or x0lo >= xhi
                        or x1hi <= ylow or x1lo >= yhi
         = ampl * g     where g is the fraction of the pixel
                        that falls within the region

This behavior is different to how the amplitude is handled in other models, such as Const2D.

Attributes Summary

`cache`	The maximum size of the cache.
`lpars`	Return any linked parameters.
`ndim`	A two-dimensional model.
`pars`	Return the parameters of the model.
`thawedparhardmaxes`	The hard maximum values for the thawed parameters.
`thawedparhardmins`	The hard minimum values for the thawed parameters.
`thawedparmaxes`	The maximum limits of the thawed parameters.
`thawedparmins`	The minimum limits of the thawed parameters.
`thawedpars`	The thawed parameters of the model.

Methods Summary

`apply`(outer, otherargs, *otherkwargs)
`cache_clear`()	Clear the cache.
`cache_status`()	Display the cache status.
`calc`(p, args, *kwargs)	Evaluate the model on a grid.
`freeze`()	Freeze any thawed parameters of the model.
`get_center`()
`get_thawed_pars`()	Return the thawed parameter objects.
`guess`(dep, args, *kwargs)	Set an initial guess for the parameter values.
`regrid`(args, *kwargs)	Allow a model to be evaluated on a different grid than requested.
`reset`()	Reset the parameter values.
`set_center`(args, *kwargs)
`startup`([cache])	Called before a model may be evaluated multiple times.
`teardown`()	Called after a model may be evaluated multiple times.
`thaw`()	Thaw any frozen parameters of the model.

Attributes Documentation

cache = 5: The maximum size of the cache.

lpars

Return any linked parameters.

This only returns linked parameters that are not related to the model, and each parameter is not repeated.

Added in version 4.16.1.

See also

pars

Examples

By default there are no linked parameters:

>>> from sherpa.models.basic import Gauss2D
>>> mdl = Gauss2D("mdl")
>>> len(mdl.pars)
6
>>> mdl.lpars
()

Force the model to have identical xpos and ypos parameters. Since the linked parameter value (mdl.xpos) is part of the model it is not included in lpars:

>>> mdl.ypos = mdl.xpos
>>> len(mdl.pars)
6
>>> mdl.lpars
()

Add a link to allow the sigma term to be fit rather than FWHM. Since the linked parameter - here from the Const1D model - is not a part of the model it is included in lpars:

>>> import numpy as np
>>> from sherpa.models.basic import Const1D
>>> sigma = Const1D("sigma")
>>> mdl.fwhm = 2 * np.sqrt(2 * np.log(2)) * sigma.c0
>>> len(mdl.pars)
6
>>> mdl.lpars
(<Parameter 'c0' of model 'sigma'>,)

ndim: int | None = 2: A two-dimensional model.

pars

Return the parameters of the model.

This does not include any linked parameters.

Changed in version 4.16.1: The pars field can no-longer be set directly. Individual elements can still be changed.

See also

lpars

thawedparhardmaxes

The hard maximum values for the thawed parameters.

The minimum and maximum range of the parameters can be changed with thawedparmins and thawedparmaxes but only within the range given by thawedparhardmins to thawparhardmaxes.

See also

thawedparhardmins, thawedparmaxes

thawedparhardmins

The hard minimum values for the thawed parameters.

The minimum and maximum range of the parameters can be changed with thawedparmins and thawedparmaxes but only within the range given by thawedparhardmins to thawparhardmaxes.

See also

thawedparhardmaxes, thawedparmins

thawedparmaxes

The maximum limits of the thawed parameters.

Get or set the maximum limits of the thawed parameters of the model as a list of numbers. If there are no thawed parameters then [] is used. The ordering matches that of the pars attribute.

See also

thawedpars, thawedarhardmaxes, thawedparmins

thawedparmins

The minimum limits of the thawed parameters.

Get or set the minimum limits of the thawed parameters of the model as a list of numbers. If there are no thawed parameters then [] is used. The ordering matches that of the pars attribute.

See also

thawedpars, thawedarhardmins, thawedparmaxes

thawedpars

The thawed parameters of the model.

Get or set the thawed parameters of the model as a list of numbers. If there are no thawed parameters then [] is used. The ordering matches that of the pars attribute.

See also

thawedparmaxes, thawedparmins

Methods Documentation

apply(outer, *otherargs, **otherkwargs) [edit on github]

cache_clear() → None [edit on github]: Clear the cache.

cache_status() → None [edit on github]

Display the cache status.

Information on the cache - the number of “hits”, “misses”, and “requests” - is displayed at the INFO logging level.

Example

>>> pl.cache_status()
 powlaw1d.pl                size:    5  hits:   633  misses:   240  check=  873

calc(p, *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).
**kwargs – Any model-specific values that are not parameters.

freeze() → None [edit on github]: Freeze any thawed parameters of the model.

get_center() [edit on github]

get_thawed_pars() → list[Parameter] [edit on github]

Return the thawed parameter objects.

This includes linked parameters, which complicates the min/max settings, since the range on the components of a linked parameter does not match that of the original parameter, which is an issue when the limits are exceeded.

Added in version 4.16.1.

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]

Allow a model to be evaluated on a different grid than requested.

The return value is a new instance of the model, set up to evaluate the model on the supplied axes which will be regridded onto the requested grid.

reset() → None [edit on github]

Reset the parameter values.

Restores each parameter to the last value it was set to. This allows the parameters to be easily reset after a fit.

set_center(*args, **kwargs) [edit on github]

startup(cache: bool = False) → None [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() → None [edit on github]: Called after a model may be evaluated multiple times.

See also

startup

thaw() → None [edit on github]

Thaw any frozen parameters of the model.

Those parameters that are marked as “always frozen” are skipped.