Box2D

class sherpa.models.basic.Box2D(name='box2d')

Bases: sherpa.models.model.ArithmeticModel

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

thawedparhardmaxes
thawedparhardmins
thawedparmaxes
thawedparmins
thawedpars

Methods Summary

apply(outer, \*otherargs, \*\*otherkwargs)
calc(\*args, \*\*kwargs)
get_center()
guess(dep, \*args, \*\*kwargs)
reset()
set_center(\*args, \*\*kwargs)
startup()
teardown()

Attributes Documentation

thawedparhardmaxes

thawedparhardmins

thawedparmaxes

thawedparmins

thawedpars

Methods Documentation

apply(outer, *otherargs, **otherkwargs)

calc(*args, **kwargs)

get_center()

guess(dep, *args, **kwargs)

reset()

set_center(*args, **kwargs)

startup()

teardown()