lsst.skymap.cellInfo.CellInfo Class Reference

Public Member Functions
def	__init__ (self, index, innerBBox, outerBBox, sequentialIndex, tractWcs)
def	getIndex (self)
def	getSequentialIndex (self)
def	getWcs (self)
def	getInnerBBox (self)
def	getOuterBBox (self)
def	getInnerSkyPolygon (self, tractWcs=None)
def	inner_sky_polygon (self)
def	getOuterSkyPolygon (self, tractWcs=None)
def	outer_sky_polygon (self)
def	__eq__ (self, rhs)
def	__ne__ (self, rhs)
def	__str__ (self)
def	__repr__ (self)

Properties
	index = property(getIndex)
	sequential_index = property(getSequentialIndex)
	wcs = property(getWcs)
	inner_bbox = property(getInnerBBox)
	outer_bbox = property(getOuterBBox)

Detailed Description

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

See `PatchInfo` and `TractInfo` for more information.

Parameters
----------
index : `lsst.skymap.Index2D`
    x,y index of a cell (a pair of ints)
innerBBox : `lsst.geom.Box2I`
    Inner bounding box.
outerBBox : `lsst.geom.Box2I`
    Outer bounding box.
sequentialIndex : `int`
    Cell sequential index.
tractWcs : `lsst.afw.geom.SkyWcs`
    Tract WCS object.

Definition at line 28 of file cellInfo.py.

Constructor & Destructor Documentation

__init__()

def lsst.skymap.cellInfo.CellInfo.__init__	(		self,
			index,
			innerBBox,
			outerBBox,
			sequentialIndex,
			tractWcs
	)

Definition at line 46 of file cellInfo.py.

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

Member Function Documentation

__eq__()

def lsst.skymap.cellInfo.CellInfo.__eq__	(		self,
			rhs
	)

Definition at line 155 of file cellInfo.py.

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

__ne__()

def lsst.skymap.cellInfo.CellInfo.__ne__	(		self,
			rhs
	)

Definition at line 160 of file cellInfo.py.

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

__repr__()

def lsst.skymap.cellInfo.CellInfo.__repr__

(

self

)

Definition at line 166 of file cellInfo.py.

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

__str__()

def lsst.skymap.cellInfo.CellInfo.__str__

(

self

)

Definition at line 163 of file cellInfo.py.

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

getIndex()

def lsst.skymap.cellInfo.CellInfo.getIndex

(

self

)

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

Returns
-------
result : `lsst.skymap.Index2D`
    Patch index (x, y).

Definition at line 55 of file cellInfo.py.

    def getIndex(self):
        """Return cell index: a tuple of (x, y)
 
        Returns
        -------
        result : `lsst.skymap.Index2D`
            Patch index (x, y).
        """
        return self._index
 

getInnerBBox()

def lsst.skymap.cellInfo.CellInfo.getInnerBBox

(

self

)

Get inner bounding box.

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

Definition at line 91 of file cellInfo.py.

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

getInnerSkyPolygon()

def lsst.skymap.cellInfo.CellInfo.getInnerSkyPolygon	(		self,
			tractWcs = None
	)

Get the inner on-sky region.

Parameters
----------
tractWcs : `lsst.afw.image.SkyWcs`, optional
    WCS for the associated tract.

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

Definition at line 115 of file cellInfo.py.

    def getInnerSkyPolygon(self, tractWcs=None):
        """Get the inner on-sky region.
 
        Parameters
        ----------
        tractWcs : `lsst.afw.image.SkyWcs`, optional
            WCS for the associated tract.
 
        Returns
        -------
        result : `lsst.sphgeom.ConvexPolygon`
            The inner sky region.
        """
        _tractWcs = tractWcs if tractWcs is not None else self._wcs
        return makeSkyPolygonFromBBox(bbox=self.getInnerBBox(), wcs=_tractWcs)
 

getOuterBBox()

def lsst.skymap.cellInfo.CellInfo.getOuterBBox

(

self

)

Get outer bounding box.

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

Definition at line 103 of file cellInfo.py.

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

getOuterSkyPolygon()

def lsst.skymap.cellInfo.CellInfo.getOuterSkyPolygon	(		self,
			tractWcs = None
	)

Get the outer on-sky region.

Parameters
----------
tractWcs : `lsst.afw.image.SkyWcs`, optional
    WCS for the associated tract.

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

Definition at line 135 of file cellInfo.py.

    def getOuterSkyPolygon(self, tractWcs=None):
        """Get the outer on-sky region.
 
        Parameters
        ----------
        tractWcs : `lsst.afw.image.SkyWcs`, optional
            WCS for the associated tract.
 
        Returns
        -------
        result : `lsst.sphgeom.ConvexPolygon`
            The outer sky region.
        """
        _tractWcs = tractWcs if tractWcs is not None else self._wcs
        return makeSkyPolygonFromBBox(bbox=self.getOuterBBox(), wcs=_tractWcs)
 

getSequentialIndex()

def lsst.skymap.cellInfo.CellInfo.getSequentialIndex

(

self

)

Return cell sequential index.

Returns
-------
result : `int`
    Sequential cell index.

Definition at line 67 of file cellInfo.py.

    def getSequentialIndex(self):
        """Return cell sequential index.
 
        Returns
        -------
        result : `int`
            Sequential cell index.
        """
        return self._sequentialIndex
 

getWcs()

def lsst.skymap.cellInfo.CellInfo.getWcs

(

self

)

Return the associated tract wcs

Returns
-------
wcs : `lsst.afw.geom.SkyWcs`
    Tract WCS.

Definition at line 79 of file cellInfo.py.

    def getWcs(self):
        """Return the associated tract wcs
 
        Returns
        -------
        wcs : `lsst.afw.geom.SkyWcs`
            Tract WCS.
        """
        return self._wcs
 

inner_sky_polygon()

def lsst.skymap.cellInfo.CellInfo.inner_sky_polygon

(

self

)

Definition at line 132 of file cellInfo.py.

    def inner_sky_polygon(self):
        return self.getInnerSkyPolygon()
 

outer_sky_polygon()

def lsst.skymap.cellInfo.CellInfo.outer_sky_polygon

(

self

)

Definition at line 152 of file cellInfo.py.

    def outer_sky_polygon(self):
        return self.getOuterSkyPolygon()
 

Property Documentation

index

lsst.skymap.cellInfo.CellInfo.index = property(getIndex)

static

Definition at line 65 of file cellInfo.py.

inner_bbox

lsst.skymap.cellInfo.CellInfo.inner_bbox = property(getInnerBBox)

static

Definition at line 101 of file cellInfo.py.

outer_bbox

lsst.skymap.cellInfo.CellInfo.outer_bbox = property(getOuterBBox)

static

Definition at line 113 of file cellInfo.py.

sequential_index

lsst.skymap.cellInfo.CellInfo.sequential_index = property(getSequentialIndex)

static

Definition at line 77 of file cellInfo.py.

wcs

lsst.skymap.cellInfo.CellInfo.wcs = property(getWcs)

static

Definition at line 89 of file cellInfo.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/skymap/22.0.1-6-g50866e6+84ff5a128b/python/lsst/skymap/cellInfo.py