Parameter¶
-
class
sherpa.models.parameter.
Parameter
(modelname, name, val, min=- 3.4028234663852886e+38, max=3.4028234663852886e+38, hard_min=- 3.4028234663852886e+38, hard_max=3.4028234663852886e+38, units='', frozen=False, alwaysfrozen=False, hidden=False, aliases=None)[source] [edit on github]¶ Bases:
sherpa.utils.NoNewAttributesAfterInit
Represent a model parameter.
- Parameters
modelname (str) – The name of the model component containing the parameter.
name (str) – The name of the parameter. It should be considered to be matched in a case-insensitive manner.
val (number) – The default value for the parameter.
min (number, optional) – The soft and hard limits for the parameter value.
max (number, optional) – The soft and hard limits for the parameter value.
hard_min (number, optional) – The soft and hard limits for the parameter value.
hard_max (number, optional) – The soft and hard limits for the parameter value.
units (str, optional) – The units for the parameter value.
frozen (bool, optional) – Does the parameter default to being frozen?
alwaysfrozen (bool, optional) – If set then the parameter can never be thawed.
hidden (bool, optional) – Should the parameter be included when displaying the model contents?
aliases (None or list of str) – If not None then alternative names for the parameter (these are expected to be matched in a case-insensitive manner).
Attributes Summary
Methods Summary
freeze
()Set the frozen attribute for the parameter.
reset
()set
([val, min, max, frozen, default_val, …])Change a parameter setting.
thaw
()Unset the frozen attribute for the parameter.
unlink
()Attributes Documentation
-
alwaysfrozen
¶
-
default_max
¶
-
default_min
¶
-
default_val
¶
-
frozen
¶
-
hard_max
¶
-
hard_min
¶
-
link
¶
-
max
¶
-
min
¶
-
val
¶
Methods Documentation
-
freeze
()[source] [edit on github]¶ Set the frozen attribute for the parameter.
See also
-
reset
()[source] [edit on github]¶
-
set
(val=None, min=None, max=None, frozen=None, default_val=None, default_min=None, default_max=None)[source] [edit on github]¶ Change a parameter setting.
-
thaw
()[source] [edit on github]¶ Unset the frozen attribute for the parameter.
See also
-
unlink
()[source] [edit on github]¶