LSSTApplications  18.1.0
LSSTDataManagementBasePackage
rangeField.py
Go to the documentation of this file.
1 #
2 # LSST Data Management System
3 # Copyright 2008, 2009, 2010 LSST Corporation.
4 #
5 # This product includes software developed by the
6 # LSST Project (http://www.lsst.org/).
7 #
8 # This program is free software: you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation, either version 3 of the License, or
11 # (at your option) any later version.
12 #
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
17 #
18 # You should have received a copy of the LSST License Statement and
19 # the GNU General Public License along with this program. If not,
20 # see <http://www.lsstcorp.org/LegalNotices/>.
21 #
22 from .config import Field, _typeStr
23 from .callStack import getStackFrame
24 
25 
26 __all__ = ["RangeField"]
27 
28 
30  """A configuration field (`lsst.pex.config.Field` subclass) that requires
31  the value to be in a specific numeric range.
32 
33  Parameters
34  ----------
35  doc : `str`
36  A description of the field.
37  dtype : {`int`-type, `float`-type}
38  The field's data type: either the `int` or `float` type.
39  default : `int` or `float`, optional
40  Default value for the field.
41  optional : `bool`, optional
42  When `False`, `lsst.pex.config.Config.validate` will fail if the
43  field's value is `None`.
44  min : int, float, or `None`, optional
45  Minimum value accepted in the range. If `None`, the range has no
46  lower bound (equivalent to negative infinity).
47  max : `int`, `float`, or None, optional
48  Maximum value accepted in the range. If `None`, the range has no
49  upper bound (equivalent to positive infinity).
50  inclusiveMin : `bool`, optional
51  If `True` (default), the ``min`` value is included in the allowed
52  range.
53  inclusiveMax : `bool`, optional
54  If `True` (default), the ``max`` value is included in the allowed
55  range.
56 
57  See also
58  --------
59  ChoiceField
60  ConfigChoiceField
61  ConfigDictField
62  ConfigField
63  ConfigurableField
64  DictField
65  Field
66  ListField
67  RegistryField
68  """
69 
70  supportedTypes = set((int, float))
71  """The set of data types allowed by `RangeField` instances (`set`
72  containing `int` and `float` types).
73  """
74 
75  def __init__(self, doc, dtype, default=None, optional=False,
76  min=None, max=None, inclusiveMin=True, inclusiveMax=False):
77  if dtype not in self.supportedTypes:
78  raise ValueError("Unsupported RangeField dtype %s" % (_typeStr(dtype)))
79  source = getStackFrame()
80  if min is None and max is None:
81  raise ValueError("min and max cannot both be None")
82 
83  if min is not None and max is not None:
84  if min > max:
85  raise ValueError("min = %s > %s = max" % (min, max))
86  elif min == max and not (inclusiveMin and inclusiveMax):
87  raise ValueError("min = max = %s and min and max not both inclusive" % (min,))
88 
89  self.min = min
90  """Minimum value accepted in the range. If `None`, the range has no
91  lower bound (equivalent to negative infinity).
92  """
93 
94  self.max = max
95  """Maximum value accepted in the range. If `None`, the range has no
96  upper bound (equivalent to positive infinity).
97  """
98 
99  if inclusiveMax:
100  self.maxCheck = lambda x, y: True if y is None else x <= y
101  else:
102  self.maxCheck = lambda x, y: True if y is None else x < y
103  if inclusiveMin:
104  self.minCheck = lambda x, y: True if y is None else x >= y
105  else:
106  self.minCheck = lambda x, y: True if y is None else x > y
107  self._setup(doc, dtype=dtype, default=default, check=None, optional=optional, source=source)
108  self.rangeString = "%s%s,%s%s" % \
109  (("[" if inclusiveMin else "("),
110  ("-inf" if self.min is None else self.min),
111  ("inf" if self.max is None else self.max),
112  ("]" if inclusiveMax else ")"))
113  """String representation of the field's allowed range (`str`).
114  """
115 
116  self.__doc__ += "\n\nValid Range = " + self.rangeString
117 
118  def _validateValue(self, value):
119  Field._validateValue(self, value)
120  if not self.minCheck(value, self.min) or \
121  not self.maxCheck(value, self.max):
122  msg = "%s is outside of valid range %s" % (value, self.rangeString)
123  raise ValueError(msg)
def __init__(self, doc, dtype, default=None, optional=False, min=None, max=None, inclusiveMin=True, inclusiveMax=False)
Definition: rangeField.py:76
daf::base::PropertySet * set
Definition: fits.cc:884
def _setup(self, doc, dtype, default, check, optional, source)
Definition: config.py:273
def getStackFrame(relative=0)
Definition: callStack.py:52