lsst.skymap  13.0-5-g2a40766+22
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | List of all members
lsst.skymap.tractInfo.ExplicitTractInfo Class Reference
Inheritance diagram for lsst.skymap.tractInfo.ExplicitTractInfo:
lsst.skymap.tractInfo.TractInfo

Public Member Functions

def __init__
 
def findPatch
 
def findPatchList
 
def getBBox
 
def getCtrCoord
 
def getId
 
def getNumPatches
 
def getPatchBorder
 
def getPatchInfo
 
def getPatchInnerDimensions
 
def getTractOverlap
 
def getVertexList
 
def getWcs
 
def __str__
 
def __repr__
 
def __iter__
 
def __len__
 
def __getitem__
 
def contains
 

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 326 of file tractInfo.py.

Constructor & Destructor Documentation

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

Definition at line 333 of file tractInfo.py.

Member Function Documentation

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

Definition at line 312 of file tractInfo.py.

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

Definition at line 302 of file tractInfo.py.

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

Definition at line 308 of file tractInfo.py.

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

Definition at line 299 of file tractInfo.py.

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

Definition at line 296 of file tractInfo.py.

def lsst.skymap.tractInfo.TractInfo.contains (   self,
  coord 
)
inherited
Does this tract contain the coordinate?

Definition at line 315 of file tractInfo.py.

def lsst.skymap.tractInfo.TractInfo.findPatch (   self,
  coord 
)
inherited
Find the patch containing the specified coord

@param[in] coord: sky coordinate (afwCoord.Coord)
@return PatchInfo of patch whose inner bbox contains the specified coord

@raise LookupError if coord is not in tract or we cannot determine the
    pixel coordinate (which likely means the coord is off the tract).

@note This routine will be more efficient if coord is ICRS.

Definition at line 155 of file tractInfo.py.

def lsst.skymap.tractInfo.TractInfo.findPatchList (   self,
  coordList 
)
inherited
Find patches containing the specified list of coords

@param[in] coordList: list of sky coordinates (afwCoord.Coord)
@return list of PatchInfo for patches that contain, or may contain, the specified region.
    The list will be empty if there is no overlap.

@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 178 of file tractInfo.py.

def lsst.skymap.tractInfo.TractInfo.getBBox (   self)
inherited
Get bounding box of tract (as an afwGeom.Box2I)

Definition at line 211 of file tractInfo.py.

def lsst.skymap.tractInfo.TractInfo.getCtrCoord (   self)
inherited
Get sky coordinate of center of tract (as an afwCoord.Coord)

Definition at line 216 of file tractInfo.py.

def lsst.skymap.tractInfo.TractInfo.getId (   self)
inherited
Get ID of tract

Definition at line 221 of file tractInfo.py.

def lsst.skymap.tractInfo.TractInfo.getNumPatches (   self)
inherited
Get the number of patches in x, y

@return the number of patches in x, y

Definition at line 226 of file tractInfo.py.

def lsst.skymap.tractInfo.TractInfo.getPatchBorder (   self)
inherited
Get batch border

@return patch border (pixels)

Definition at line 233 of file tractInfo.py.

def lsst.skymap.tractInfo.TractInfo.getPatchInfo (   self,
  index 
)
inherited
Return information for the specified patch

@param[in] index: index of patch, as a pair of ints
@return patch info, an instance of PatchInfo

@raise IndexError if index is out of range

Definition at line 240 of file tractInfo.py.

def lsst.skymap.tractInfo.TractInfo.getPatchInnerDimensions (   self)
inherited
Get dimensions of inner region of the patches (all are the same)

@return dimensions of inner region of the patches (as an afwGeom Extent2I)

Definition at line 267 of file tractInfo.py.

def lsst.skymap.tractInfo.TractInfo.getTractOverlap (   self)
inherited
Get minimum overlap of adjacent sky tracts

@return minimum overlap between adjacent sky tracts, as an afwGeom Angle

Definition at line 274 of file tractInfo.py.

def lsst.skymap.tractInfo.TractInfo.getVertexList (   self)
inherited
Get list of sky coordinates of vertices that define the boundary of the inner region

@warning: this is not a deep copy
@warning vertexCoordList will likely become a geom SphericalConvexPolygon someday.

Definition at line 281 of file tractInfo.py.

def lsst.skymap.tractInfo.TractInfo.getWcs (   self)
inherited
Get WCS of tract

@warning: this is not a deep copy

Definition at line 289 of file tractInfo.py.


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