lsst.skymap gc3e9b769f7+dcad4ace9a
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Protected Attributes | Static Protected 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

 __init__ (self, config=None)
 
 __getstate__ (self)
 
 __setstate__ (self, stateDict)
 
 findTract (self, coord)
 
 getVersion (self)
 
 getWithTractsOnPoles (self)
 
 updateSha1 (self, sha1)
 

Static Public Attributes

 ConfigClass = DodecaSkyMapConfig
 

Protected Attributes

 _dodecahedron
 

Static Protected Attributes

tuple _version = (1, 0)
 

Detailed Description

Dodecahedron-based sky map pixelization.

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

Parameters
----------
config : `lsst.skymap.BaseSkyMapConfig` (optional)
    The configuration for this SkyMap; if None use the default config.

Definition at line 54 of file dodecaSkyMap.py.

Constructor & Destructor Documentation

◆ __init__()

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

Reimplemented from lsst.skymap.baseSkyMap.BaseSkyMap.

Definition at line 68 of file dodecaSkyMap.py.

Member Function Documentation

◆ __getstate__()

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

Returns
-------
result : `dict`
    A dict containing:
    - version: a pair of ints
    - config: the config

Definition at line 95 of file dodecaSkyMap.py.

◆ __setstate__()

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

Parameters
----------
stateDict : `dict`
    - version: a pair of ints
    - config: the config

Definition at line 110 of file dodecaSkyMap.py.

◆ findTract()

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

Parameters
----------
coord : `lsst.geom.SpherePoint`
    ICRS sky coordinate to search for.

Returns
-------
tractInfo : `TractInfo`
    Info for tract whose inner region includes the coord.

Reimplemented from lsst.skymap.baseSkyMap.BaseSkyMap.

Definition at line 124 of file dodecaSkyMap.py.

◆ getVersion()

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

Returns
-------
version : `tuple` of `int`
    Version as a pair of integers.

Definition at line 139 of file dodecaSkyMap.py.

◆ getWithTractsOnPoles()

lsst.skymap.dodecaSkyMap.DodecaSkyMap.getWithTractsOnPoles ( self)
Return True if there are tracts centered on the poles.

Definition at line 149 of file dodecaSkyMap.py.

◆ updateSha1()

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

Reimplemented from lsst.skymap.baseSkyMap.BaseSkyMap.

Definition at line 154 of file dodecaSkyMap.py.

Member Data Documentation

◆ _dodecahedron

lsst.skymap.dodecaSkyMap.DodecaSkyMap._dodecahedron
protected

Definition at line 70 of file dodecaSkyMap.py.

◆ _version

tuple lsst.skymap.dodecaSkyMap.DodecaSkyMap._version = (1, 0)
staticprotected

Definition at line 66 of file dodecaSkyMap.py.

◆ ConfigClass

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

Definition at line 65 of file dodecaSkyMap.py.


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