Box1D¶
-
class
sherpa.models.basic.
Box1D
(name='box1d')[source]¶ Bases:
sherpa.models.model.RegriddableModel1D
One-dimensional box function.
The model is flat between
xlow
andxhi
(both limits are inclusive), where it is set to theampl
parameter. Outside this range the model is zero.-
xlow
¶ The lower edge of the box.
-
xhi
¶ The upper edge of the box.
-
ampl
¶ The amplitude of the box.
Notes
The functional form of the model for points is:
f(x) = ampl if xlow <= x <= xhi = 0 otherwise
and for an integrated grid it is:
f(lo,hi) = ampl if lo >= xlow and hi <= xhi = 0 if hi <= xlow or lo >= xhi = ampl * g where g is the fraction of lo,hi that falls within xlo,xhi
This behavior is different to how the amplitude is handled in other models, such as
Const1D
.Attributes Summary
thawedparhardmaxes
thawedparhardmins
thawedparmaxes
thawedparmins
thawedpars
Methods Summary
apply
(outer, *otherargs, **otherkwargs)calc
(pars, xlo, *args, **kwargs)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)¶
-
calc
(pars, xlo, *args, **kwargs)¶
-
get_center
()¶
-
guess
(dep, *args, **kwargs)[source]¶ 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)¶
-
reset
()¶
-
set_center
(*args, **kwargs)¶
-
startup
()¶ Called before a model may be evaluated multiple times.
See also
-
teardown
()¶ Called after a model may be evaluated multiple times.
See also
setup()
-