lsst.skymap  13.0-4-gd4595c5
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.skymap.baseSkyMap.BaseSkyMap Class Reference
Inheritance diagram for lsst.skymap.baseSkyMap.BaseSkyMap:

Public Member Functions

def __init__
 
def findTract
 
def findTractPatchList
 
def findClosestTractPatchList
 
def __getitem__
 
def __iter__
 
def __len__
 

Public Attributes

 config
 

Static Public Attributes

 ConfigClass = BaseSkyMapConfig
 

Detailed Description

A collection of overlapping Tracts that map part or all of the sky.

See TractInfo for more information.

BaseSkyMap is an abstract base class. Subclasses must do the following:
@li define __init__ and have it construct the TractInfo objects and put them in _tractInfoList
@li define __getstate__ and __setstate__ to allow pickling (the butler saves sky maps using pickle);
    see DodecaSkyMap for an example of how to do this. (Most of that code could be moved
    into this base class, but that would make it harder to handle older versions of pickle data.)

Definition at line 72 of file baseSkyMap.py.

Constructor & Destructor Documentation

def lsst.skymap.baseSkyMap.BaseSkyMap.__init__ (   self,
  config = None 
)
Construct a BaseSkyMap

@param[in] config: an instance of self.ConfigClass; if None the default config is used

Definition at line 85 of file baseSkyMap.py.

Member Function Documentation

def lsst.skymap.baseSkyMap.BaseSkyMap.__getitem__ (   self,
  ind 
)

Definition at line 155 of file baseSkyMap.py.

def lsst.skymap.baseSkyMap.BaseSkyMap.__iter__ (   self)

Definition at line 158 of file baseSkyMap.py.

def lsst.skymap.baseSkyMap.BaseSkyMap.__len__ (   self)

Definition at line 161 of file baseSkyMap.py.

def lsst.skymap.baseSkyMap.BaseSkyMap.findClosestTractPatchList (   self,
  coordList 
)
Find closest tract and patches that overlap coordinates

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

Definition at line 140 of file baseSkyMap.py.

def lsst.skymap.baseSkyMap.BaseSkyMap.findTract (   self,
  coord 
)
Find the tract whose center is nearest the specified coord.

@param[in] coord: sky coordinate (afwCoord.Coord)
@return TractInfo of tract whose center is nearest the specified coord

@warning:
- if tracts do not cover the whole sky then the returned tract may not include the coord

@note
- This routine will be more efficient if coord is ICRS.
- If coord is equidistant between multiple sky tract centers then one is arbitrarily chosen.
- The default implementation is not very efficient; subclasses may wish to override.

Definition at line 101 of file baseSkyMap.py.

def lsst.skymap.baseSkyMap.BaseSkyMap.findTractPatchList (   self,
  coordList 
)
Find tracts and patches that overlap a region

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

@warning this uses a naive algorithm that may find some tracts and patches that do not overlap
    the region (especially if the region is not a rectangle aligned along patch x,y).

Definition at line 123 of file baseSkyMap.py.

Member Data Documentation

lsst.skymap.baseSkyMap.BaseSkyMap.config

Definition at line 93 of file baseSkyMap.py.

lsst.skymap.baseSkyMap.BaseSkyMap.ConfigClass = BaseSkyMapConfig
static

Definition at line 83 of file baseSkyMap.py.


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