DodecaSkyMap¶

class lsst.skymap.DodecaSkyMap(config=None)¶

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.

Methods Summary

`findClosestTractPatchList`(coordList)	Find closest tract and patches that overlap coordinates.
`findTract`(coord)	Find the tract whose inner region includes the coord.
`findTractPatchList`(coordList)	Find tracts and patches that overlap a region.
`getSha1`()	Return a SHA1 hash that uniquely identifies this SkyMap instance.
`getVersion`()	Return version (e.g.
`getWithTractsOnPoles`()	Return True if there are tracts centered on the poles.
`logSkyMapInfo`(log)	Write information about a sky map to supplied log
`register`(name, registry)	Add SkyMap, Tract, and Patch Dimension entries to the given Gen3 Butler Registry.
`updateSha1`(sha1)	Add subclass-specific state or configuration options to the SHA1.

Methods Documentation

findClosestTractPatchList(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.

findTract(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.

findTractPatchList(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).

getSha1()¶

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.

getVersion()¶

Return version (e.g. for pickle).

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

getWithTractsOnPoles()¶: Return True if there are tracts centered on the poles.

logSkyMapInfo(log)¶

Write information about a sky map to supplied log

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

register(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.

updateSha1(sha1)¶: Add subclass-specific state or configuration options to the SHA1.