Public Member Functions
def	__init__ (self, index, innerBBox, outerBBox)

def	getIndex (self)

def	getInnerBBox (self)

def	getOuterBBox (self)

def	getInnerSkyPolygon (self, tractWcs)

def	getOuterSkyPolygon (self, tractWcs)

def	__eq__ (self, rhs)

def	__ne__ (self, rhs)

def	__str__ (self)

def	__repr__ (self)

Detailed Description

Information about a patch within a tract of a sky map.

See `TractInfo` for more information.

Parameters
----------
index : `tuple` of `int`
    x,y index of patch (a pair of ints)
innerBBox : `lsst.geom.Box2I`
    inner bounding box
outerBBox : `lsst.geom.Box2I`
    inner bounding box

Definition at line 49 of file patchInfo.py.

Constructor & Destructor Documentation

◆ init()

def lsst.skymap.patchInfo.PatchInfo.__init__	(	self,
		index,
		innerBBox,
		outerBBox
	)

Definition at line 64 of file patchInfo.py.

     def __init__(self, index, innerBBox, outerBBox):
         self._index = index
         self._innerBBox = innerBBox
         self._outerBBox = outerBBox
         if not outerBBox.contains(innerBBox):
             raise RuntimeError("outerBBox=%s does not contain innerBBox=%s" % (outerBBox, innerBBox))
 

Member Function Documentation

◆ eq()

def lsst.skymap.patchInfo.PatchInfo.__eq__	(	self,
		rhs
	)

Definition at line 121 of file patchInfo.py.

     def __eq__(self, rhs):
         return (self.getIndex() == rhs.getIndex()) \
             and (self.getInnerBBox() == rhs.getInnerBBox()) \
             and (self.getOuterBBox() == rhs.getOuterBBox())
 

◆ ne()

def lsst.skymap.patchInfo.PatchInfo.__ne__	(	self,
		rhs
	)

Definition at line 126 of file patchInfo.py.

     def __ne__(self, rhs):
         return not self.__eq__(rhs)
 

◆ repr()

def lsst.skymap.patchInfo.PatchInfo.__repr__ ( self )

Definition at line 132 of file patchInfo.py.

     def __repr__(self):
         return "PatchInfo(index=%s, innerBBox=%s, outerBBox=%s)" % \
             (self.getIndex(), self.getInnerBBox(), self.getOuterBBox())
 

◆ str()

def lsst.skymap.patchInfo.PatchInfo.__str__ ( self )

Definition at line 129 of file patchInfo.py.

     def __str__(self):
         return "PatchInfo(index=%s)" % (self.getIndex(),)
 

◆ getIndex()

def lsst.skymap.patchInfo.PatchInfo.getIndex ( self )

Return patch index: a tuple of (x, y)

Returns
-------
result : `tuple` of `int`
    Patch index (x, y).

Definition at line 71 of file patchInfo.py.

     def getIndex(self):
         """Return patch index: a tuple of (x, y)
 
         Returns
         -------
         result : `tuple` of `int`
             Patch index (x, y).
         """
         return self._index
 

◆ getInnerBBox()

def lsst.skymap.patchInfo.PatchInfo.getInnerBBox ( self )

Get inner bounding box.

Returns
-------
bbox : `lsst.geom.Box2I`
    The inner bounding Box.

Definition at line 81 of file patchInfo.py.

     def getInnerBBox(self):
         """Get inner bounding box.
 
         Returns
         -------
         bbox : `lsst.geom.Box2I`
             The inner bounding Box.
         """
         return self._innerBBox
 

◆ getInnerSkyPolygon()

def lsst.skymap.patchInfo.PatchInfo.getInnerSkyPolygon	(	self,
		tractWcs
	)

Get the inner on-sky region.

Returns
-------
result : `lsst.sphgeom.ConvexPolygon`
    The inner sky region.

Definition at line 101 of file patchInfo.py.

     def getInnerSkyPolygon(self, tractWcs):
         """Get the inner on-sky region.
 
         Returns
         -------
         result : `lsst.sphgeom.ConvexPolygon`
             The inner sky region.
         """
         return makeSkyPolygonFromBBox(bbox=self.getInnerBBox(), wcs=tractWcs)
 

◆ getOuterBBox()

def lsst.skymap.patchInfo.PatchInfo.getOuterBBox ( self )

Get outer bounding box.

Returns
-------
bbox : `lsst.geom.Box2I`
    The outer bounding Box.

Definition at line 91 of file patchInfo.py.

     def getOuterBBox(self):
         """Get outer bounding box.
 
         Returns
         -------
         bbox : `lsst.geom.Box2I`
             The outer bounding Box.
         """
         return self._outerBBox
 

◆ getOuterSkyPolygon()

def lsst.skymap.patchInfo.PatchInfo.getOuterSkyPolygon	(	self,
		tractWcs
	)

Get the outer on-sky region.

Returns
-------
result : `lsst.sphgeom.ConvexPolygon`
    The outer sky region.

Definition at line 111 of file patchInfo.py.

     def getOuterSkyPolygon(self, tractWcs):
         """Get the outer on-sky region.
 
         Returns
         -------
         result : `lsst.sphgeom.ConvexPolygon`
             The outer sky region.
         """
         return makeSkyPolygonFromBBox(bbox=self.getOuterBBox(), wcs=tractWcs)
 

The documentation for this class was generated from the following file:

/j/snowflake/release/lsstsw/stack/Linux64/skymap/17.0.1-4-g59d126d+4/python/lsst/skymap/patchInfo.py

Public Member Functions