CachingSkyMap

class lsst.skymap.cachingSkyMap.CachingSkyMap(numTracts, config=None, version=0)

Bases: lsst.skymap.BaseSkyMap

A SkyMap that generates its tracts on request and caches them.

Parameters:
numTracts : int

Number of tracts to create.

config : lsst.skymap.BaseSkyMapConfig (optional)

The configuration for this SkyMap; if None use the default config.

version : int or tuple of int (optional)

Software version of this class, to retain compatibility with old instances.

Notes

A subclass should define * __init__ to calculate the required number of tracts (and pass it up) * generateTract to generate a tract

Subclassers should also check that the arguments to the constructor are consistent with the below __reduce__ method.

Methods Summary

findClosestTractPatchList(coordList) Find closest tract and patches that overlap coordinates.
findTract(coord) Find the tract whose center is nearest the specified coord.
findTractPatchList(coordList) Find tracts and patches that overlap a region.
generateTract(index) Generate TractInfo for the specified tract index.
getSha1() Return a SHA1 hash that uniquely identifies this SkyMap instance.
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 center is nearest the specified coord.

Parameters:
coord : lsst.geom.SpherePoint

ICRS sky coordinate to search for.
Returns:
result : TractInfo

TractInfo of tract whose center is nearest the specified coord.

Notes

  • If coord is equidistant between multiple sky tract centers then one is arbitrarily chosen.
  • The default implementation is not very efficient; subclasses may wish to override.

Warning: If tracts do not cover the whole sky then the returned tract may not include 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).
generateTract(index)

Generate TractInfo for the specified tract index.

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.

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.

Parameters:
sha1 : hashlib.sha1

A hashlib object on which update can be called to add additional state to the hash.

Notes

This method is conceptually “protected” : it should be reimplemented by all subclasses, but called only by the base class implementation of getSha1 .