lsst.skymap.dodecaSkyMap.DodecaSkyMap Class Reference

Inheritance diagram for lsst.skymap.dodecaSkyMap.DodecaSkyMap:

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)

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.

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__()

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

Reimplemented from lsst.skymap.baseSkyMap.BaseSkyMap.

Definition at line 68 of file dodecaSkyMap.py.

    def __init__(self, config=None):
        BaseSkyMap.__init__(self, config)
        self._dodecahedron = detail.Dodecahedron(withFacesOnPoles=self.config.withTractsOnPoles)
 
        tractOverlap = geom.Angle(self.config.tractOverlap, geom.degrees)
 
        for id in range(12):
            tractVec = self._dodecahedron.getFaceCtr(id)
            tractCoord = detail.coordFromVec(tractVec, defRA=geom.Angle(0))
            tractRA = tractCoord.getLongitude()
            vertexVecList = self._dodecahedron.getVertices(id)
 
            # make initial WCS; don't worry about crPixPos because TractInfo will shift it as required
            wcs = self._wcsFactory.makeWcs(crPixPos=geom.Point2D(0, 0), crValCoord=tractCoord)
 
            self._tractInfoList.append(
                TractInfo(
                    id=id,
                    tractBuilder=self._tractBuilder,
                    ctrCoord=tractCoord,
                    vertexCoordList=[detail.coordFromVec(vec, defRA=tractRA) for vec in vertexVecList],
                    tractOverlap=tractOverlap,
                    wcs=wcs,
                )
            )
 

Member Function Documentation

__getstate__()

def 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 94 of file dodecaSkyMap.py.

    def __getstate__(self):
        """Support pickle.
 
        Returns
        -------
        result : `dict`
            A dict containing:
            - version: a pair of ints
            - config: the config
        """
        return dict(
            version=self._version,
            config=self.config,
        )
 

__setstate__()

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

Support unpickle

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

Definition at line 109 of file dodecaSkyMap.py.

    def __setstate__(self, stateDict):
        """Support unpickle
 
        Parameters
        ----------
        stateDict : `dict`
            - version: a pair of ints
            - config: the config
        """
        version = stateDict["version"]
        if version >= (2, 0):
            raise RuntimeError("Version = %s >= (2,0); cannot unpickle" % (version,))
        self.__init__(stateDict["config"])
 

findTract()

def 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 123 of file dodecaSkyMap.py.

    def 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.
        """
        return self[self._dodecahedron.getFaceInd(coord.getVector())]
 

getVersion()

def 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 138 of file dodecaSkyMap.py.

    def getVersion(self):
        """Return version (e.g. for pickle).
 
        Returns
        -------
        version : `tuple` of `int`
            Version as a pair of integers.
        """
        return self._version
 

getWithTractsOnPoles()

def lsst.skymap.dodecaSkyMap.DodecaSkyMap.getWithTractsOnPoles

(

self

)

Return True if there are tracts centered on the poles.

Definition at line 148 of file dodecaSkyMap.py.

    def getWithTractsOnPoles(self):
        """Return True if there are tracts centered on the poles.
        """
        return self._dodecahedron.getWithFacesOnPoles()
 

updateSha1()

def 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 153 of file dodecaSkyMap.py.

    def updateSha1(self, sha1):
        """Add subclass-specific state or configuration options to the SHA1."""
        sha1.update(struct.pack("<?", self.config.withTractsOnPoles))

Member Data Documentation

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:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-4.0.1/Linux64/skymap/gdb4cecd868+6f279b5b48/python/lsst/skymap/dodecaSkyMap.py