lsst.skymap  14.0-2-g8373656+11
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.skymap.equatSkyMap.EquatSkyMap Class Reference
Inheritance diagram for lsst.skymap.equatSkyMap.EquatSkyMap:
lsst.skymap.baseSkyMap.BaseSkyMap

Public Member Functions

def __init__ (self, config=None)
 
def __getstate__ (self)
 
def __setstate__ (self, stateDict)
 
def getVersion (self)
 
def findTract (self, coord)
 
def findTractPatchList (self, coordList)
 
def findClosestTractPatchList (self, coordList)
 
def __getitem__ (self, ind)
 
def __iter__ (self)
 
def __len__ (self)
 

Public Attributes

 config
 

Static Public Attributes

 ConfigClass = EquatSkyMapConfig
 

Detailed Description

Equatorial sky map pixelization, e.g. for SDSS stripe 82 image data.

EquatSkyMap represents an equatorial band of sky divided along declination into overlapping tracts.

Definition at line 49 of file equatSkyMap.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.skymap.equatSkyMap.EquatSkyMap.__init__ (   self,
  config = None 
)
Construct a EquatSkyMap

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

Definition at line 57 of file equatSkyMap.py.

Member Function Documentation

◆ __getitem__()

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

Definition at line 155 of file baseSkyMap.py.

◆ __getstate__()

def lsst.skymap.equatSkyMap.EquatSkyMap.__getstate__ (   self)
Support pickle

@return a dict containing:
- version: a pair of ints
- config: the config

Definition at line 98 of file equatSkyMap.py.

◆ __iter__()

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

Definition at line 158 of file baseSkyMap.py.

◆ __len__()

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

Definition at line 161 of file baseSkyMap.py.

◆ __setstate__()

def lsst.skymap.equatSkyMap.EquatSkyMap.__setstate__ (   self,
  stateDict 
)
Support unpickle

@param[in] stateDict: a dict containing:
- version: a pair of ints
- config: the config

Definition at line 110 of file equatSkyMap.py.

◆ findClosestTractPatchList()

def lsst.skymap.baseSkyMap.BaseSkyMap.findClosestTractPatchList (   self,
  coordList 
)
inherited
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.

◆ findTract()

def lsst.skymap.baseSkyMap.BaseSkyMap.findTract (   self,
  coord 
)
inherited
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.

◆ findTractPatchList()

def lsst.skymap.baseSkyMap.BaseSkyMap.findTractPatchList (   self,
  coordList 
)
inherited
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.

◆ getVersion()

def lsst.skymap.equatSkyMap.EquatSkyMap.getVersion (   self)
Return version (e.g. for pickle)

@return version as a pair of integers

Definition at line 122 of file equatSkyMap.py.

Member Data Documentation

◆ config

lsst.skymap.baseSkyMap.BaseSkyMap.config
inherited

Definition at line 93 of file baseSkyMap.py.

◆ ConfigClass

lsst.skymap.equatSkyMap.EquatSkyMap.ConfigClass = EquatSkyMapConfig
static

Definition at line 54 of file equatSkyMap.py.


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