lsst.skymap  16.0-7-g00e1f5f
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__ (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 347 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 354 of file tractInfo.py.

Member Function Documentation

◆ __getitem__()

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

Definition at line 334 of file tractInfo.py.

◆ __iter__()

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

Definition at line 324 of file tractInfo.py.

◆ __len__()

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

Definition at line 330 of file tractInfo.py.

◆ __repr__()

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

Definition at line 321 of file tractInfo.py.

◆ __str__()

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

Definition at line 318 of file tractInfo.py.

◆ contains()

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

Definition at line 337 of file tractInfo.py.

◆ findPatch()

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

@param[in] coord: ICRS sky coordinate (lsst.afw.geom.SpherePoint)
@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 165 of file tractInfo.py.

◆ findPatchList()

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

@param[in] coordList: list of sky coordinates (lsst.afw.geom.SpherePoint)
@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 187 of file tractInfo.py.

◆ getBBox()

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

Definition at line 219 of file tractInfo.py.

◆ getCtrCoord()

def lsst.skymap.tractInfo.TractInfo.getCtrCoord (   self)
inherited
Get ICRS sky coordinate of center of tract (as an lsst.afw.geom.SpherePoint)

Definition at line 224 of file tractInfo.py.

◆ getId()

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

Definition at line 229 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 300 of file tractInfo.py.

◆ getNumPatches()

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

◆ getPatchBorder()

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

@return patch border (pixels)

Definition at line 241 of file tractInfo.py.

◆ getPatchIndexPair()

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

Definition at line 159 of file tractInfo.py.

◆ getPatchInfo()

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,
    or a sequential index as returned by getSequentialPatchIndex;
    negative values are not supported.
@return patch info, an instance of PatchInfo

@raise IndexError if index is out of range

Definition at line 248 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)

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

Definition at line 279 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 151 of file tractInfo.py.

◆ getTractOverlap()

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

◆ getVertexList()

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

Definition at line 293 of file tractInfo.py.

◆ getWcs()

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

@warning: this is not a deep copy

Definition at line 311 of file tractInfo.py.


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