lsst.skymap.patchInfo.PatchInfo Class Reference

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.

Member Function Documentation

__eq__()

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

Definition at line 121 of file patchInfo.py.

__ne__()

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

Definition at line 126 of file patchInfo.py.

__repr__()

def lsst.skymap.patchInfo.PatchInfo.__repr__

(

self

)

Definition at line 132 of file patchInfo.py.

__str__()

def lsst.skymap.patchInfo.PatchInfo.__str__

(

self

)

Definition at line 129 of file patchInfo.py.

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.

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.

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.

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.

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.

---

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

• python/lsst/skymap/patchInfo.py