LSST Applications g0d97872fb5+4fd969bb9d,g1653933729+34a971ddd9,g28da252d5a+072f89fe25,g2bbee38e9b+a99b0ab4cd,g2bc492864f+a99b0ab4cd,g2ca4be77d2+c0e3b27cd8,g2cdde0e794+704103fe75,g3156d2b45e+6e87dc994a,g347aa1857d+a99b0ab4cd,g35bb328faa+34a971ddd9,g3a166c0a6a+a99b0ab4cd,g3e281a1b8c+8ec26ec694,g4005a62e65+ba0306790b,g414038480c+9ed5ed841a,g569e0e2b34+cb4faa46ad,g5a97de2502+520531a62c,g717e5f8c0f+29153700a5,g7ede599f99+367733290c,g80478fca09+17051a22cc,g82479be7b0+f2f1ea0a87,g858d7b2824+29153700a5,g8b782ad322+29153700a5,g8cd86fa7b1+05420e7f7d,g9125e01d80+34a971ddd9,ga5288a1d22+e7f674aaf3,gae0086650b+34a971ddd9,gae74b0b5c6+45ef5cdc51,gb58c049af0+ace264a4f2,gc28159a63d+a99b0ab4cd,gcf0d15dbbd+8051a81198,gda6a2b7d83+8051a81198,gdaeeff99f8+7774323b41,gdf4d240d4a+34a971ddd9,ge2409df99d+cb167bac99,ge33fd446bb+29153700a5,ge79ae78c31+a99b0ab4cd,gf0baf85859+890af219f9,gf5289d68f6+9faa5c5784,w.2024.36
LSST Data Management Base Package
|
Public Member Functions | |
__init__ (self, doc, dtype, default=None, optional=False, min=None, max=None, inclusiveMin=True, inclusiveMax=False, deprecated=None) | |
Public Attributes | |
min | |
max | |
maxCheck | |
minCheck | |
rangeString | |
Static Public Attributes | |
dict | supportedTypes = {int, float} |
Protected Member Functions | |
_validateValue (self, value) | |
A configuration field (`lsst.pex.config.Field` subclass) that requires the value to be in a specific numeric range. Parameters ---------- doc : `str` A description of the field. dtype : {`int`-type, `float`-type} The field's data type: either the `int` or `float` type. default : `int` or `float`, optional Default value for the field. optional : `bool`, optional When `False`, `lsst.pex.config.Config.validate` will fail if the field's value is `None`. min : int, float, or `None`, optional Minimum value accepted in the range. If `None`, the range has no lower bound (equivalent to negative infinity). max : `int`, `float`, or None, optional Maximum value accepted in the range. If `None`, the range has no upper bound (equivalent to positive infinity). inclusiveMin : `bool`, optional If `True`, the ``min`` value is included in the allowed range. inclusiveMax : `bool`, optional If `True`, the ``max`` value is included in the allowed range. deprecated : None or `str`, optional A description of why this Field is deprecated, including removal date. If not None, the string is appended to the docstring for this Field. See Also -------- ChoiceField ConfigChoiceField ConfigDictField ConfigField ConfigurableField DictField Field ListField RegistryField
Definition at line 34 of file rangeField.py.
lsst.pex.config.rangeField.RangeField.__init__ | ( | self, | |
doc, | |||
dtype, | |||
default = None, | |||
optional = False, | |||
min = None, | |||
max = None, | |||
inclusiveMin = True, | |||
inclusiveMax = False, | |||
deprecated = None ) |
Reimplemented from lsst.pex.config.config.Field.
Definition at line 81 of file rangeField.py.
|
protected |
Validate a value. Parameters ---------- value : object The value being validated. Raises ------ TypeError Raised if the value's type is incompatible with the field's ``dtype``. ValueError Raised if the value is rejected by the ``check`` method.
Reimplemented from lsst.pex.config.config.Field.
Definition at line 143 of file rangeField.py.
lsst.pex.config.rangeField.RangeField.max |
Definition at line 110 of file rangeField.py.
lsst.pex.config.rangeField.RangeField.maxCheck |
Definition at line 116 of file rangeField.py.
lsst.pex.config.rangeField.RangeField.min |
Definition at line 105 of file rangeField.py.
lsst.pex.config.rangeField.RangeField.minCheck |
Definition at line 120 of file rangeField.py.
lsst.pex.config.rangeField.RangeField.rangeString |
Definition at line 132 of file rangeField.py.
|
static |
Definition at line 76 of file rangeField.py.