DodecaSkyMap¶
-
class
lsst.skymap.
DodecaSkyMap
(config=None)¶ Bases:
lsst.skymap.BaseSkyMap
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.
Attributes Summary
SKYMAP_DATASET_TYPE_NAME
SKYMAP_RUN_COLLECTION_NAME
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, butler)Add skymap, tract, and patch Dimension entries to the given Gen3 Butler. updateSha1
(sha1)Add subclass-specific state or configuration options to the SHA1. Attributes Documentation
-
SKYMAP_DATASET_TYPE_NAME
= 'skyMap'¶
-
SKYMAP_RUN_COLLECTION_NAME
= 'skymaps'¶
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.
- coordList :
-
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.
- coord :
-
findTractPatchList
(coordList)¶ Find tracts and patches that overlap a region.
Parameters: - coordList :
list
oflsst.geom.SpherePoint
List of ICRS sky coordinates to search for.
Returns: 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).
- coordList :
-
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.- sha1 :
-
getVersion
()¶ Return version (e.g. for pickle).
Returns:
-
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
- log :
-
register
(name, butler)¶ Add skymap, tract, and patch Dimension entries to the given Gen3 Butler.
Parameters: - name :
str
The name of the skymap.
- butler :
lsst.daf.butler.Butler
The butler to add to.
Raises: - lsst.daf.butler.registry.ConflictingDefinitionError
Raised if a different skymap exists with the same name.
Notes
Registering the same skymap multiple times (with the exact same definition) is safe, but inefficient; most of the work of computing the rows to be inserted must be done first in order to check for consistency between the new skymap and any existing one.
Re-registering a skymap with different tract and/or patch definitions but the same summary information may not be detected as a conflict but will never result in updating the skymap; there is intentionally no way to modify a registered skymap (aside from manual administrative operations on the database), as it is hard to guarantee that this can be done without affecting reproducibility.
- name :
-
updateSha1
(sha1)¶ Add subclass-specific state or configuration options to the SHA1.
- config :