Inheritance diagram for lsst.skymap.dodecaSkyMap.DodecaSkyMap:
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.
68 def __init__(self, config=None):
69 BaseSkyMap.__init__(self, config)
70 self._dodecahedron = detail.Dodecahedron(withFacesOnPoles=self.config.withTractsOnPoles)
71
72 tractOverlap = geom.Angle(self.config.tractOverlap, geom.degrees)
73
74 for id in range(12):
75 tractVec = self._dodecahedron.getFaceCtr(id)
76 tractCoord = detail.coordFromVec(tractVec, defRA=geom.Angle(0))
77 tractRA = tractCoord.getLongitude()
78 vertexVecList = self._dodecahedron.getVertices(id)
79
80 # Make initial WCS; don't worry about crPixPos because TractInfo
81 # will shift it as required.
82 wcs = self._wcsFactory.makeWcs(crPixPos=geom.Point2D(0, 0), crValCoord=tractCoord)
83
84 self._tractInfoList.append(
85 TractInfo(
86 id=id,
87 tractBuilder=self._tractBuilder,
88 ctrCoord=tractCoord,
89 vertexCoordList=[detail.coordFromVec(vec, defRA=tractRA) for vec in vertexVecList],
90 tractOverlap=tractOverlap,
91 wcs=wcs,
92 )
93 )
94
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.
95 def __getstate__(self):
96 """Support pickle.
97
98 Returns
99 -------
100 result : `dict`
101 A dict containing:
102 - version: a pair of ints
103 - config: the config
104 """
105 return dict(
106 version=self._version,
107 config=self.config,
108 )
109
◆ __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.
110 def __setstate__(self, stateDict):
111 """Support unpickle
112
113 Parameters
114 ----------
115 stateDict : `dict`
116 - version: a pair of ints
117 - config: the config
118 """
119 version = stateDict["version"]
120 if version >= (2, 0):
121 raise RuntimeError("Version = %s >= (2,0); cannot unpickle" % (version,))
122 self.__init__(stateDict["config"])
123
◆ 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.
124 def findTract(self, coord):
125 """Find the tract whose inner region includes the coord.
126
127 Parameters
128 ----------
129 coord : `lsst.geom.SpherePoint`
130 ICRS sky coordinate to search for.
131
132 Returns
133 -------
134 tractInfo : `TractInfo`
135 Info for tract whose inner region includes the coord.
136 """
137 return self[self._dodecahedron.getFaceInd(coord.getVector())]
138
◆ 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.
139 def getVersion(self):
140 """Return version (e.g. for pickle).
141
142 Returns
143 -------
144 version : `tuple` of `int`
145 Version as a pair of integers.
146 """
147 return self._version
148
◆ 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.
149 def getWithTractsOnPoles(self):
150 """Return True if there are tracts centered on the poles.
151 """
152 return self._dodecahedron.getWithFacesOnPoles()
153
◆ 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.
154 def updateSha1(self, sha1):
155 """Add subclass-specific state or configuration options to the SHA1."""
156 sha1.update(struct.pack("<?", self.config.withTractsOnPoles))
Member Data Documentation
◆ _dodecahedron
|
protected |
Definition at line 70 of file dodecaSkyMap.py.
◆ _version
|
staticprotected |
Definition at line 66 of file dodecaSkyMap.py.
◆ ConfigClass
|
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-8.0.0/Linux64/skymap/ga8c6da7877+71e4819109/python/lsst/skymap/dodecaSkyMap.py
