lsst.skymap.tractInfo.ExplicitTractInfo Class Reference

Inheritance diagram for lsst.skymap.tractInfo.ExplicitTractInfo:

Public Member Functions
def	__init__ (self, ident, patchInnerDimensions, patchBorder, ctrCoord, radius, tractOverlap, wcs)
def	getSequentialPatchIndex (self, patchInfo)
def	getPatchIndexPair (self, sequentialIndex)
def	findPatch (self, coord)
def	findPatchList (self, coordList)
def	getBBox (self)
def	getCtrCoord (self)
def	getId (self)
def	getNumPatches (self)
def	getPatchBorder (self)
def	getPatchInfo (self, index)
def	getPatchInnerDimensions (self)
def	getTractOverlap (self)
def	getVertexList (self)
def	getInnerSkyPolygon (self)
def	getOuterSkyPolygon (self)
def	getWcs (self)
def	__str__ (self)
def	__repr__ (self)
def	__iter__ (self)
def	__len__ (self)
def	__getitem__ (self, index)
def	contains (self, coord)

Detailed Description

Information for a tract specified explicitly.

A tract is placed at the explicitly defined coordinates, with the nominated
radius.  The tracts are square (i.e., the radius is really a half-size).

Definition at line 418 of file tractInfo.py.

Constructor & Destructor Documentation

__init__()

def lsst.skymap.tractInfo.ExplicitTractInfo.__init__	(		self,
			ident,
			patchInnerDimensions,
			patchBorder,
			ctrCoord,
			radius,
			tractOverlap,
			wcs
	)

Reimplemented from lsst.skymap.tractInfo.TractInfo.

Definition at line 425 of file tractInfo.py.

    def __init__(self, ident, patchInnerDimensions, patchBorder, ctrCoord, radius, tractOverlap, wcs):
        # We don't want TractInfo setting the bbox on the basis of vertices, but on the radius.
        vertexList = []
        self._radius = radius
        super(ExplicitTractInfo, self).__init__(ident, patchInnerDimensions, patchBorder, ctrCoord,
                                                vertexList, tractOverlap, wcs)
        # Shrink the box slightly to make sure the vertices are in the tract
        bboxD = geom.BoxD(self.getBBox())
        bboxD.grow(-0.001)
        finalWcs = self.getWcs()
        self._vertexCoordList = finalWcs.pixelToSky(bboxD.getCorners())
 

Member Function Documentation

__getitem__()

def lsst.skymap.tractInfo.TractInfo.__getitem__ (   self,   index  )

inherited

Definition at line 405 of file tractInfo.py.

    def __getitem__(self, index):
        return self.getPatchInfo(index)
 

__iter__()

def lsst.skymap.tractInfo.TractInfo.__iter__ (   self )

inherited

Definition at line 395 of file tractInfo.py.

    def __iter__(self):
        xNum, yNum = self.getNumPatches()
        for y in range(yNum):
            for x in range(xNum):
                yield self.getPatchInfo((x, y))
 

__len__()

def lsst.skymap.tractInfo.TractInfo.__len__ (   self )

inherited

Definition at line 401 of file tractInfo.py.

    def __len__(self):
        xNum, yNum = self.getNumPatches()
        return xNum*yNum
 

__repr__()

def lsst.skymap.tractInfo.TractInfo.__repr__ (   self )

inherited

Definition at line 392 of file tractInfo.py.

    def __repr__(self):
        return "TractInfo(id=%s, ctrCoord=%s)" % (self._id, self._ctrCoord.getVector())
 

__str__()

def lsst.skymap.tractInfo.TractInfo.__str__ (   self )

inherited

Definition at line 389 of file tractInfo.py.

    def __str__(self):
        return "TractInfo(id=%s)" % (self._id,)
 

contains()

def lsst.skymap.tractInfo.TractInfo.contains (   self,   coord  )

inherited

Does this tract contain the coordinate?

Definition at line 408 of file tractInfo.py.

    def contains(self, coord):
        """Does this tract contain the coordinate?"""
        try:
            pixels = self.getWcs().skyToPixel(coord)
        except (lsst.pex.exceptions.DomainError, lsst.pex.exceptions.RuntimeError):
            # Point must be way off the tract
            return False
        return self.getBBox().contains(geom.Point2I(pixels))
 
 

findPatch()

def lsst.skymap.tractInfo.TractInfo.findPatch (   self,   coord  )

inherited

Find the patch containing the specified coord.

Parameters
----------
coord : `lsst.geom.SpherePoint`
    ICRS sky coordinate to search for.

Returns
-------
result : `lsst.skymap.PatchInfo`
    PatchInfo of patch whose inner bbox contains the specified coord

Raises
------
LookupError
    If coord is not in tract or we cannot determine the
    pixel coordinate (which likely means the coord is off the tract).

Definition at line 203 of file tractInfo.py.

    def findPatch(self, coord):
        """Find the patch containing the specified coord.
 
        Parameters
        ----------
        coord : `lsst.geom.SpherePoint`
            ICRS sky coordinate to search for.
 
        Returns
        -------
        result : `lsst.skymap.PatchInfo`
            PatchInfo of patch whose inner bbox contains the specified coord
 
        Raises
        ------
        LookupError
            If coord is not in tract or we cannot determine the
            pixel coordinate (which likely means the coord is off the tract).
        """
        try:
            pixel = self.getWcs().skyToPixel(coord)
        except (lsst.pex.exceptions.DomainError, lsst.pex.exceptions.RuntimeError):
            # Point must be way off the tract
            raise LookupError("Unable to determine pixel position for coordinate %s" % (coord,))
        pixelInd = geom.Point2I(pixel)
        if not self.getBBox().contains(pixelInd):
            raise LookupError("coord %s is not in tract %s" % (coord, self.getId()))
        patchInd = tuple(int(pixelInd[i]/self._patchInnerDimensions[i]) for i in range(2))
        return self.getPatchInfo(patchInd)
 

findPatchList()

def lsst.skymap.tractInfo.TractInfo.findPatchList (   self,   coordList  )

inherited

Find patches containing the specified list of coords.

Parameters
----------
coordList : `list` of `lsst.geom.SpherePoint`
    ICRS sky coordinates to search for.

Returns
-------
result : `list` of `lsst.skymap.PatchInfo`
    List of PatchInfo for patches that contain, or may contain, the
    specified region. The list will be empty if there is no overlap.

Notes
-----
**Warning:**

- This may give incorrect answers on regions that are larger than a
  tract.

- This uses a naive algorithm that may find some patches that do not
  overlap the region (especially if the region is not a rectangle
  aligned along patch x,y).

Definition at line 233 of file tractInfo.py.

    def findPatchList(self, coordList):
        """Find patches containing the specified list of coords.
 
        Parameters
        ----------
        coordList : `list` of `lsst.geom.SpherePoint`
            ICRS sky coordinates to search for.
 
        Returns
        -------
        result : `list` of `lsst.skymap.PatchInfo`
            List of PatchInfo for patches that contain, or may contain, the
            specified region. The list will be empty if there is no overlap.
 
        Notes
        -----
        **Warning:**
 
        - This may give incorrect answers on regions that are larger than a
          tract.
 
        - This uses a naive algorithm that may find some patches that do not
          overlap the region (especially if the region is not a rectangle
          aligned along patch x,y).
        """
        box2D = geom.Box2D()
        for coord in coordList:
            try:
                pixelPos = self.getWcs().skyToPixel(coord)
            except (lsst.pex.exceptions.DomainError, lsst.pex.exceptions.RuntimeError):
                # the point is so far off the tract that its pixel position cannot be computed
                continue
            box2D.include(pixelPos)
        bbox = geom.Box2I(box2D)
        bbox.grow(self.getPatchBorder())
        bbox.clip(self.getBBox())
        if bbox.isEmpty():
            return ()
 
        llPatchInd = tuple(int(bbox.getMin()[i]/self._patchInnerDimensions[i]) for i in range(2))
        urPatchInd = tuple(int(bbox.getMax()[i]/self._patchInnerDimensions[i]) for i in range(2))
        return tuple(self.getPatchInfo((xInd, yInd))
                     for xInd in range(llPatchInd[0], urPatchInd[0]+1)
                     for yInd in range(llPatchInd[1], urPatchInd[1]+1))
 

getBBox()

def lsst.skymap.tractInfo.TractInfo.getBBox (   self )

inherited

Get bounding box of tract (as an geom.Box2I)

Definition at line 278 of file tractInfo.py.

    def getBBox(self):
        """Get bounding box of tract (as an geom.Box2I)
        """
        return geom.Box2I(self._bbox)
 

getCtrCoord()

def lsst.skymap.tractInfo.TractInfo.getCtrCoord (   self )

inherited

Get ICRS sky coordinate of center of tract
(as an lsst.geom.SpherePoint)

Definition at line 283 of file tractInfo.py.

    def getCtrCoord(self):
        """Get ICRS sky coordinate of center of tract
        (as an lsst.geom.SpherePoint)
        """
        return self._ctrCoord
 

getId()

def lsst.skymap.tractInfo.TractInfo.getId (   self )

inherited

Get ID of tract

Definition at line 289 of file tractInfo.py.

    def getId(self):
        """Get ID of tract
        """
        return self._id
 

getInnerSkyPolygon()

def lsst.skymap.tractInfo.TractInfo.getInnerSkyPolygon (   self )

inherited

Get inner on-sky region as a sphgeom.ConvexPolygon.

Definition at line 368 of file tractInfo.py.

    def getInnerSkyPolygon(self):
        """Get inner on-sky region as a sphgeom.ConvexPolygon.
        """
        skyUnitVectors = [sp.getVector() for sp in self.getVertexList()]
        return ConvexPolygon.convexHull(skyUnitVectors)
 

getNumPatches()

def lsst.skymap.tractInfo.TractInfo.getNumPatches (   self )

inherited

Get the number of patches in x, y.

Returns
-------
result : `tuple` of `int`
    The number of patches in x, y

Definition at line 294 of file tractInfo.py.

    def getNumPatches(self):
        """Get the number of patches in x, y.
 
        Returns
        -------
        result : `tuple` of `int`
            The number of patches in x, y
        """
        return self._numPatches
 

getOuterSkyPolygon()

def lsst.skymap.tractInfo.TractInfo.getOuterSkyPolygon (   self )

inherited

Get outer on-sky region as a sphgeom.ConvexPolygon

Definition at line 374 of file tractInfo.py.

    def getOuterSkyPolygon(self):
        """Get outer on-sky region as a sphgeom.ConvexPolygon
        """
        return makeSkyPolygonFromBBox(bbox=self.getBBox(), wcs=self.getWcs())
 

getPatchBorder()

def lsst.skymap.tractInfo.TractInfo.getPatchBorder (   self )

inherited

Definition at line 304 of file tractInfo.py.

    def getPatchBorder(self):
        return self._patchBorder
 

getPatchIndexPair()

def lsst.skymap.tractInfo.TractInfo.getPatchIndexPair (   self,   sequentialIndex  )

inherited

Definition at line 197 of file tractInfo.py.

    def getPatchIndexPair(self, sequentialIndex):
        nx, ny = self.getNumPatches()
        x = sequentialIndex % nx
        y = (sequentialIndex - x) // nx
        return (x, y)
 

getPatchInfo()

def lsst.skymap.tractInfo.TractInfo.getPatchInfo (   self,   index  )

inherited

Return information for the specified patch.

Parameters
----------
index : `tuple` of `int`
    Index of patch, as a pair of ints;
    or a sequential index as returned by getSequentialPatchIndex;
    negative values are not supported.

Returns
-------
result : `lsst.skymap.PatchInfo`
    The patch info for that index.

Raises
------
IndexError
    If index is out of range.

Definition at line 307 of file tractInfo.py.

    def getPatchInfo(self, index):
        """Return information for the specified patch.
 
        Parameters
        ----------
        index : `tuple` of `int`
            Index of patch, as a pair of ints;
            or a sequential index as returned by getSequentialPatchIndex;
            negative values are not supported.
 
        Returns
        -------
        result : `lsst.skymap.PatchInfo`
            The patch info for that index.
 
        Raises
        ------
        IndexError
            If index is out of range.
        """
        if isinstance(index, numbers.Number):
            index = self.getPatchIndexPair(index)
        if (not 0 <= index[0] < self._numPatches[0]) \
                or (not 0 <= index[1] < self._numPatches[1]):
            raise IndexError("Patch index %s is not in range [0-%d, 0-%d]" %
                             (index, self._numPatches[0]-1, self._numPatches[1]-1))
        innerMin = geom.Point2I(*[index[i] * self._patchInnerDimensions[i] for i in range(2)])
        innerBBox = geom.Box2I(innerMin, self._patchInnerDimensions)
        if not self._bbox.contains(innerBBox):
            raise RuntimeError(
                "Bug: patch index %s valid but inner bbox=%s not contained in tract bbox=%s" %
                (index, innerBBox, self._bbox))
        outerBBox = geom.Box2I(innerBBox)
        outerBBox.grow(self.getPatchBorder())
        outerBBox.clip(self._bbox)
        return PatchInfo(
            index=index,
            innerBBox=innerBBox,
            outerBBox=outerBBox,
        )
 

getPatchInnerDimensions()

def lsst.skymap.tractInfo.TractInfo.getPatchInnerDimensions (   self )

inherited

Get dimensions of inner region of the patches (all are the same)

Definition at line 348 of file tractInfo.py.

    def getPatchInnerDimensions(self):
        """Get dimensions of inner region of the patches (all are the same)
        """
        return self._patchInnerDimensions
 

getSequentialPatchIndex()

def lsst.skymap.tractInfo.TractInfo.getSequentialPatchIndex (   self,   patchInfo  )

inherited

Return a single integer that uniquely identifies the given patch
within this tract.

Definition at line 189 of file tractInfo.py.

    def getSequentialPatchIndex(self, patchInfo):
        """Return a single integer that uniquely identifies the given patch
        within this tract.
        """
        x, y = patchInfo.getIndex()
        nx, ny = self.getNumPatches()
        return nx*y + x
 

getTractOverlap()

def lsst.skymap.tractInfo.TractInfo.getTractOverlap (   self )

inherited

Get minimum overlap of adjacent sky tracts.

Definition at line 353 of file tractInfo.py.

    def getTractOverlap(self):
        """Get minimum overlap of adjacent sky tracts.
        """
        return self._tractOverlap
 

getVertexList()

def lsst.skymap.tractInfo.TractInfo.getVertexList (   self )

inherited

Get list of ICRS sky coordinates of vertices that define the
boundary of the inner region.

Notes
-----
**warning:** this is not a deep copy.

Definition at line 358 of file tractInfo.py.

    def getVertexList(self):
        """Get list of ICRS sky coordinates of vertices that define the
        boundary of the inner region.
 
        Notes
        -----
        **warning:** this is not a deep copy.
        """
        return self._vertexCoordList
 

getWcs()

def lsst.skymap.tractInfo.TractInfo.getWcs (   self )

inherited

Get WCS of tract.

Returns
-------
wcs : `lsst.afw.geom.SkyWcs`
    The WCS of this tract

Definition at line 379 of file tractInfo.py.

    def getWcs(self):
        """Get WCS of tract.
 
        Returns
        -------
        wcs : `lsst.afw.geom.SkyWcs`
            The WCS of this tract
        """
        return self._wcs
 

---

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-4-g037fbe1+64e601228d/python/lsst/skymap/tractInfo.py