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)

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	logSkyMapInfo (self, log)

def	getSha1 (self)

def	register (self, name, registry)

Public Attributes
	config

Static Public Attributes
	ConfigClass

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,
                     patchInnerDimensions=self.config.patchInnerDimensions,
                     patchBorder=self.config.patchBorder,
                     ctrCoord=tractCoord,
                     vertexCoordList=[detail.coordFromVec(vec, defRA=tractRA) for vec in vertexVecList],
                     tractOverlap=tractOverlap,
                     wcs=wcs,
                 )
             )
  

Member Function Documentation

◆ eq()

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

inherited

Definition at line 212 of file baseSkyMap.py.

     def __eq__(self, other):
         try:
             return self.getSha1() == other.getSha1()
         except AttributeError:
             return NotImplemented
  

◆ getitem()

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

inherited

Reimplemented in lsst.skymap.cachingSkyMap.CachingSkyMap.

Definition at line 200 of file baseSkyMap.py.

     def __getitem__(self, ind):
         return self._tractInfoList[ind]
  

◆ 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 95 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,
         )
  

◆ hash()

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

inherited

Definition at line 209 of file baseSkyMap.py.

     def __hash__(self):
         return hash(self.getSha1())
  

◆ iter()

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

inherited

Reimplemented in lsst.skymap.cachingSkyMap.CachingSkyMap.

Definition at line 203 of file baseSkyMap.py.

     def __iter__(self):
         return iter(self._tractInfoList)
  

◆ len()

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

inherited

Reimplemented in lsst.skymap.cachingSkyMap.CachingSkyMap.

Definition at line 206 of file baseSkyMap.py.

     def __len__(self):
         return len(self._tractInfoList)
  

◆ ne()

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

inherited

Definition at line 218 of file baseSkyMap.py.

     def __ne__(self, other):
         return not (self == other)
  

◆ 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 110 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"])
  

◆ findClosestTractPatchList()

def lsst.skymap.baseSkyMap.BaseSkyMap.findClosestTractPatchList	(	self,
		coordList
	)

inherited

Find closest tract and patches that overlap coordinates.

Parameters
----------
coordList : `lsst.geom.SpherePoint`
    List of ICRS sky coordinates to search for.

Returns
-------
retList : `list`
    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 177 of file baseSkyMap.py.

     def findClosestTractPatchList(self, coordList):
         """Find closest tract and patches that overlap coordinates.
  
         Parameters
         ----------
         coordList : `lsst.geom.SpherePoint`
             List of ICRS sky coordinates to search for.
  
         Returns
         -------
         retList : `list`
             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.
         """
         retList = []
         for coord in coordList:
             tractInfo = self.findTract(coord)
             patchList = tractInfo.findPatchList(coordList)
             if patchList and not (tractInfo, patchList) in retList:
                 retList.append((tractInfo, patchList))
         return retList
  

◆ 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 124 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())]
  

◆ findTractPatchList()

def lsst.skymap.baseSkyMap.BaseSkyMap.findTractPatchList	(	self,
		coordList
	)

inherited

Find tracts and patches that overlap a region.

Parameters
----------
coordList : `list` of `lsst.geom.SpherePoint`
    List of ICRS sky coordinates to search for.

Returns
-------
reList : `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.

Notes
-----
**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).

Reimplemented in lsst.skymap.ringsSkyMap.RingsSkyMap.

Definition at line 149 of file baseSkyMap.py.

     def findTractPatchList(self, coordList):
         """Find tracts and patches that overlap a region.
  
         Parameters
         ----------
         coordList : `list` of `lsst.geom.SpherePoint`
             List of ICRS sky coordinates to search for.
  
         Returns
         -------
         reList : `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.
  
         Notes
         -----
         **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).
         """
         retList = []
         for tractInfo in self:
             patchList = tractInfo.findPatchList(coordList)
             if patchList:
                 retList.append((tractInfo, patchList))
         return retList
  

◆ 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.

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

Definition at line 245 of file baseSkyMap.py.

     def getSha1(self):
         """Return a SHA1 hash that uniquely identifies this SkyMap instance.
  
         Returns
         -------
         sha1 : `bytes`
             A 20-byte hash that uniquely identifies this SkyMap instance.
  
         Notes
         -----
         Subclasses should almost always override ``updateSha1`` instead of
         this function to add subclass-specific state to the hash.
         """
         if self._sha1 is None:
             sha1 = hashlib.sha1()
             sha1.update(type(self).__name__.encode('utf-8'))
             configPacked = struct.pack(
                 "<iiidd3sd",
                 self.config.patchInnerDimensions[0],
                 self.config.patchInnerDimensions[1],
                 self.config.patchBorder,
                 self.config.tractOverlap,
                 self.config.pixelScale,
                 self.config.projection.encode('ascii'),
                 self.config.rotation
             )
             sha1.update(configPacked)
             self.updateSha1(sha1)
             self._sha1 = sha1.digest()
         return self._sha1
  

◆ 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 139 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 149 of file dodecaSkyMap.py.

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

◆ logSkyMapInfo()

def lsst.skymap.baseSkyMap.BaseSkyMap.logSkyMapInfo	(	self,
		log
	)

inherited

Write information about a sky map to supplied log

Parameters
----------
log : `lsst.log.Log`
    Log object that information about skymap will be written

Definition at line 221 of file baseSkyMap.py.

     def logSkyMapInfo(self, log):
         """Write information about a sky map to supplied log
  
         Parameters
         ----------
         log : `lsst.log.Log`
             Log object that information about skymap will be written
         """
         log.info("sky map has %s tracts" % (len(self),))
         for tractInfo in self:
             wcs = tractInfo.getWcs()
             posBox = geom.Box2D(tractInfo.getBBox())
             pixelPosList = (
                 posBox.getMin(),
                 geom.Point2D(posBox.getMaxX(), posBox.getMinY()),
                 posBox.getMax(),
                 geom.Point2D(posBox.getMinX(), posBox.getMaxY()),
             )
             skyPosList = [wcs.pixelToSky(pos).getPosition(geom.degrees) for pos in pixelPosList]
             posStrList = ["(%0.3f, %0.3f)" % tuple(skyPos) for skyPos in skyPosList]
             log.info("tract %s has corners %s (RA, Dec deg) and %s x %s patches" %
                      (tractInfo.getId(), ", ".join(posStrList),
                       tractInfo.getNumPatches()[0], tractInfo.getNumPatches()[1]))
  

◆ register()

def lsst.skymap.baseSkyMap.BaseSkyMap.register	(	self,
		name,
		registry
	)

inherited

Add SkyMap, Tract, and Patch Dimension entries to the given Gen3
Butler Registry.

Parameters
----------
name : `str`
    The name of the skymap.
registry : `lsst.daf.butler.Registry`
    The registry to add to.

Definition at line 293 of file baseSkyMap.py.

     def register(self, name, registry):
         """Add SkyMap, Tract, and Patch Dimension entries to the given Gen3
         Butler Registry.
  
         Parameters
         ----------
         name : `str`
             The name of the skymap.
         registry : `lsst.daf.butler.Registry`
             The registry to add to.
         """
         nxMax = 0
         nyMax = 0
         records = {
             "skymap": [],
             "tract": [],
             "patch": [],
         }
         for tractInfo in self:
             nx, ny = tractInfo.getNumPatches()
             nxMax = max(nxMax, nx)
             nyMax = max(nyMax, ny)
             region = tractInfo.getOuterSkyPolygon()
             centroid = SpherePoint(region.getCentroid())
             records["tract"].append({
                 "skymap": name,
                 "tract": tractInfo.getId(),
                 "region": region,
                 "ra": centroid.getRa().asDegrees(),
                 "dec": centroid.getDec().asDegrees(),
             })
             for patchInfo in tractInfo:
                 cellX, cellY = patchInfo.getIndex()
                 records["patch"].append({
                     "skymap": name,
                     "tract": tractInfo.getId(),
                     "patch": tractInfo.getSequentialPatchIndex(patchInfo),
                     "cell_x": cellX,
                     "cell_y": cellY,
                     "region": patchInfo.getOuterSkyPolygon(tractInfo.getWcs()),
                 })
         records["skymap"].append({
             "skymap": name,
             "hash": self.getSha1(),
             "tract_max": len(self),
             "patch_nx_max": nxMax,
             "patch_ny_max": nyMax,
         })
         with registry.transaction():
             for dimension, recordsForDimension in records.items():
                 registry.insertDimensionData(dimension, *recordsForDimension)

◆ 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 154 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

◆ config

lsst.skymap.baseSkyMap.BaseSkyMap.config

inherited

Definition at line 107 of file baseSkyMap.py.

◆ ConfigClass

lsst.skymap.dodecaSkyMap.DodecaSkyMap.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/1a1d771/Linux64/skymap/20.0.0/python/lsst/skymap/dodecaSkyMap.py

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __eq__()

◆ __getitem__()

◆ __getstate__()

◆ __hash__()

◆ __iter__()

◆ __len__()

◆ __ne__()

◆ __setstate__()

◆ findClosestTractPatchList()

◆ findTract()

◆ findTractPatchList()

◆ getSha1()

◆ getVersion()

◆ getWithTractsOnPoles()

◆ logSkyMapInfo()

◆ register()

◆ updateSha1()

Member Data Documentation

◆ config

◆ ConfigClass

◆ init()

◆ eq()

◆ getitem()

◆ getstate()

◆ hash()

◆ iter()

◆ len()

◆ ne()

◆ setstate()