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]

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.
  • max, hard_min, hard_max (min,) – 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

alwaysfrozen
default_max
default_min
default_val
frozen
hard_max
hard_min
link
max
min
val

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
max
min
val

Methods Documentation

freeze()[source]

Set the frozen attribute for the parameter.

See also

thaw()

reset()[source]
set(val=None, min=None, max=None, frozen=None, default_val=None, default_min=None, default_max=None)[source]

Change a parameter setting.

thaw()[source]

Unset the frozen attribute for the parameter.

See also

frozen()