lsst.skymap  16.0-4-g13a27c5+16
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.skymap.dodecaSkyMap.DodecaSkyMap Class Reference
Inheritance diagram for lsst.skymap.dodecaSkyMap.DodecaSkyMap:
lsst.skymap.baseSkyMap.BaseSkyMap

Public Member Functions

def __init__ (self, config=None)
 
def __getstate__ (self)
 
def __setstate__ (self, stateDict)
 
def findTract (self, coord)
 
def getVersion (self)
 
def getWithTractsOnPoles (self)
 
def updateSha1 (self, sha1)
 
def findTractPatchList (self, coordList)
 
def findClosestTractPatchList (self, coordList)
 
def __getitem__ (self, ind)
 
def __iter__ (self)
 
def __len__ (self)
 
def __hash__ (self)
 
def __eq__ (self, other)
 
def __ne__ (self, other)
 
def getSha1 (self)
 
def register (self, name, registry)
 

Public Attributes

 config
 

Static Public Attributes

 ConfigClass = DodecaSkyMapConfig
 

Detailed Description

Dodecahedron-based sky map pixelization.

DodecaSkyMap divides the sky into 12 overlapping Tracts arranged as the faces of a dodecahedron.

Definition at line 52 of file dodecaSkyMap.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.skymap.dodecaSkyMap.DodecaSkyMap.__init__ (   self,
  config = None 
)
Construct a DodecaSkyMap

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

Definition at line 60 of file dodecaSkyMap.py.

Member Function Documentation

◆ __eq__()

def lsst.skymap.baseSkyMap.BaseSkyMap.__eq__ (   self,
  other 
)
inherited

Definition at line 175 of file baseSkyMap.py.

◆ __getitem__()

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

Definition at line 163 of file baseSkyMap.py.

◆ __getstate__()

def lsst.skymap.dodecaSkyMap.DodecaSkyMap.__getstate__ (   self)
Support pickle

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

Definition at line 91 of file dodecaSkyMap.py.

◆ __hash__()

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

Definition at line 172 of file baseSkyMap.py.

◆ __iter__()

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

Definition at line 166 of file baseSkyMap.py.

◆ __len__()

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

Definition at line 169 of file baseSkyMap.py.

◆ __ne__()

def lsst.skymap.baseSkyMap.BaseSkyMap.__ne__ (   self,
  other 
)
inherited

Definition at line 181 of file baseSkyMap.py.

◆ __setstate__()

def lsst.skymap.dodecaSkyMap.DodecaSkyMap.__setstate__ (   self,
  stateDict 
)
Support unpickle

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

Definition at line 103 of file dodecaSkyMap.py.

◆ findClosestTractPatchList()

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

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

◆ findTract()

def lsst.skymap.dodecaSkyMap.DodecaSkyMap.findTract (   self,
  coord 
)
Find the tract whose inner region includes the coord.

@param[in] coord: ICRS sky coordinate (lsst.afw.geom.SpherePoint)
@return TractInfo for tract whose inner region includes the coord.

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

Definition at line 115 of file dodecaSkyMap.py.

◆ findTractPatchList()

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

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

◆ getSha1()

def lsst.skymap.baseSkyMap.BaseSkyMap.getSha1 (   self)
inherited
Return a SHA1 hash that uniquely identifies this SkyMap instance.

Returns
-------
sha1 : bytes
    A 20-byte hash that uniquely identifies this SkyMap instance.

Subclasses should almost always override `updateSha1()` instead of
this function to add subclass-specific state to the hash.

Definition at line 184 of file baseSkyMap.py.

◆ getVersion()

def lsst.skymap.dodecaSkyMap.DodecaSkyMap.getVersion (   self)
Return version (e.g. for pickle)

@return version as a pair of integers

Definition at line 125 of file dodecaSkyMap.py.

◆ getWithTractsOnPoles()

def lsst.skymap.dodecaSkyMap.DodecaSkyMap.getWithTractsOnPoles (   self)
Return withTractsOnPoles parameter

@return withTractsOnPoles as a bool

Definition at line 132 of file dodecaSkyMap.py.

◆ register()

def lsst.skymap.baseSkyMap.BaseSkyMap.register (   self,
  name,
  registry 
)
inherited
Add SkyMap, Tract, and Patch DataUnits to the given Gen3 Butler Registry.

Definition at line 228 of file baseSkyMap.py.

◆ updateSha1()

def lsst.skymap.dodecaSkyMap.DodecaSkyMap.updateSha1 (   self,
  sha1 
)
Add subclass-specific state or configuration options to the SHA1.

Definition at line 139 of file dodecaSkyMap.py.

Member Data Documentation

◆ config

lsst.skymap.baseSkyMap.BaseSkyMap.config
inherited

Definition at line 100 of file baseSkyMap.py.

◆ ConfigClass

lsst.skymap.dodecaSkyMap.DodecaSkyMap.ConfigClass = DodecaSkyMapConfig
static

Definition at line 57 of file dodecaSkyMap.py.


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