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
	)

Definition at line 425 of file tractInfo.py.

Member Function Documentation

__getitem__()

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

inherited

Definition at line 405 of file tractInfo.py.

__iter__()

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

inherited

Definition at line 395 of file tractInfo.py.

__len__()

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

inherited

Definition at line 401 of file tractInfo.py.

__repr__()

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

inherited

Definition at line 392 of file tractInfo.py.

__str__()

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

inherited

Definition at line 389 of file tractInfo.py.

contains()

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

inherited

Does this tract contain the coordinate?

Definition at line 408 of file tractInfo.py.

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.

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.

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.

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.

getId()

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

inherited

Get ID of tract

Definition at line 289 of file tractInfo.py.

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.

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.

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.

getPatchBorder()

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

inherited

Definition at line 304 of file tractInfo.py.

getPatchIndexPair()

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

inherited

Definition at line 197 of file tractInfo.py.

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.

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.

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.

getTractOverlap()

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

inherited

Get minimum overlap of adjacent sky tracts.

Definition at line 353 of file tractInfo.py.

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.

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.

---

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

• python/lsst/skymap/tractInfo.py