LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
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.