LSST Applications g0265f82a02+0e5473021a,g02d81e74bb+0dd8ce4237,g1470d8bcf6+3ea6592b6f,g2079a07aa2+86d27d4dc4,g2305ad1205+5ca4c0b359,g295015adf3+d10818ec9d,g2a9a014e59+6f9be1b9cd,g2bbee38e9b+0e5473021a,g337abbeb29+0e5473021a,g3ddfee87b4+703ba97ebf,g487adcacf7+4fa16da234,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+ffa42b374e,g5a732f18d5+53520f316c,g64a986408d+0dd8ce4237,g858d7b2824+0dd8ce4237,g8a8a8dda67+585e252eca,g99cad8db69+d39438377f,g9ddcbc5298+9a081db1e4,ga1e77700b3+15fc3df1f7,ga8c6da7877+f1d96605c8,gb0e22166c9+60f28cb32d,gb6a65358fc+0e5473021a,gba4ed39666+c2a2e4ac27,gbb8dafda3b+e5339d463f,gc120e1dc64+da31e9920e,gc28159a63d+0e5473021a,gcf0d15dbbd+703ba97ebf,gdaeeff99f8+f9a426f77a,ge6526c86ff+889fc9d533,ge79ae78c31+0e5473021a,gee10cc3b42+585e252eca,gf18bd8381d+7268b93478,gff1a9f87cc+0dd8ce4237,w.2024.16
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.