lsst.skymap  14.0-4-g3609236+10
patchInfo.py
Go to the documentation of this file.
1 from builtins import object
2 #
3 # LSST Data Management System
4 # Copyright 2008, 2009, 2010 LSST Corporation.
5 #
6 # This product includes software developed by the
7 # LSST Project (http://www.lsst.org/).
8 #
9 # This program is free software: you can redistribute it and/or modify
10 # it under the terms of the GNU General Public License as published by
11 # the Free Software Foundation, either version 3 of the License, or
12 # (at your option) any later version.
13 #
14 # This program is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 # GNU General Public License for more details.
18 #
19 # You should have received a copy of the LSST License Statement and
20 # the GNU General Public License along with this program. If not,
21 # see <http://www.lsstcorp.org/LegalNotices/>.
22 #
23 __all__ = ["PatchInfo"]
24 
25 
26 class PatchInfo(object):
27  """Information about a patch within a tract of a sky map
28 
29  See TractInfo for more information.
30  """
31 
32  def __init__(self, index, innerBBox, outerBBox):
33  """Construct a PatchInfo
34 
35  @param[in] index: x,y index of patch (a pair of ints)
36  @param[in] innerBBox: inner bounding box (an afwGeom.Box2I)
37  @param[in] outerBBox: inner bounding box (an afwGeom.Box2I)
38  """
39  self._index = index
40  self._innerBBox = innerBBox
41  self._outerBBox = outerBBox
42  if not outerBBox.contains(innerBBox):
43  raise RuntimeError("outerBBox=%s does not contain innerBBox=%s" % (outerBBox, innerBBox))
44 
45  def getIndex(self):
46  """Get patch index
47  """
48  return self._index
49 
50  def getInnerBBox(self):
51  """Get inner bounding box
52  """
53  return self._innerBBox
54 
55  def getOuterBBox(self):
56  """Get outer bounding box
57  """
58  return self._outerBBox
59 
60  def __eq__(self, rhs):
61  """Support ==
62  """
63  return (self.getIndex() == rhs.getIndex()) \
64  and (self.getInnerBBox() == rhs.getInnerBBox()) \
65  and (self.getOuterBBox() == rhs.getOuterBBox())
66 
67  def __ne__(self, rhs):
68  """Support !=
69  """
70  return not self.__eq__(rhs)
71 
72  def __str__(self):
73  """Return a brief string representation
74  """
75  return "PatchInfo(index=%s)" % (self.getIndex(),)
76 
77  def __repr__(self):
78  """Return a detailed string representation
79  """
80  return "PatchInfo(index=%s, innerBBox=%s, outerBBox=%s)" % \
81  (self.getIndex(), self.getInnerBBox(), self.getOuterBBox())
def __init__(self, index, innerBBox, outerBBox)
Definition: patchInfo.py:32