ArithmeticConstantModel¶
-
class
sherpa.models.model.
ArithmeticConstantModel
(val, name=None)[source] [edit on github]¶ Bases:
sherpa.models.model.Model
Represent a constant value, or values.
- Parameters
val (number or sequence) – The number, or numbers, to store.
name (str or None, optional) – The display name. If not set the value is used when the value is a scalar, otherwise it indicates an array of elements.
-
val
¶ - Type
number
Attributes Summary
The hard maximum values for the thawed parameters.
The hard minimum values for the thawed parameters.
Access to the maximum limits for the thawed parameters
Access to the minimum limits for the thawed parameters
Access to the thawed parameters of the model
The constant value (scalar or 1D).
Methods Summary
calc
(p, *args, **kwargs)Evaluate the model on a grid.
guess
(dep, *args, **kwargs)Set an initial guess for the parameter values.
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.
Attributes Documentation
-
ndim
= None¶
-
thawedparhardmaxes
¶ The hard maximum values for the thawed parameters.
-
thawedparhardmins
¶ The hard minimum values for the thawed parameters.
-
thawedparmaxes
¶ Access to the maximum limits for the thawed parameters
-
thawedparmins
¶ Access to the minimum limits for the thawed parameters
-
thawedpars
¶ Access to the thawed parameters of the model
-
val
¶ The constant value (scalar or 1D).
Methods Documentation
-
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).
-
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.
-
reset
() [edit on github]¶ Reset the parameter values.
-
set_center
(*args, **kwargs) [edit on github]¶
-
startup
(cache=False)[source] [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
()[source] [edit on github]¶ Called after a model may be evaluated multiple times.
See also
setup()