lsst.skymap
17.0.1-2-g18434ef+1
|
Public Member Functions | |
def | __init__ (self, numTracts, config=None, version=0) |
def | __reduce__ (self) |
def | __iter__ (self) |
def | __len__ (self) |
def | __getitem__ (self, index) |
def | generateTract (self, index) |
def | findTract (self, coord) |
def | findTractPatchList (self, coordList) |
def | findClosestTractPatchList (self, coordList) |
def | __hash__ (self) |
def | __eq__ (self, other) |
def | __ne__ (self, other) |
def | getSha1 (self) |
def | updateSha1 (self, sha1) |
def | register (self, name, registry) |
Public Attributes | |
config | |
Static Public Attributes | |
ConfigClass = BaseSkyMapConfig | |
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.
Definition at line 28 of file cachingSkyMap.py.
def lsst.skymap.cachingSkyMap.CachingSkyMap.__init__ | ( | self, | |
numTracts, | |||
config = None , |
|||
version = 0 |
|||
) |
Definition at line 51 of file cachingSkyMap.py.
|
inherited |
Definition at line 211 of file baseSkyMap.py.
def lsst.skymap.cachingSkyMap.CachingSkyMap.__getitem__ | ( | self, | |
index | |||
) |
Get the TractInfo for a particular index. The tract is returned from a cache, if available, otherwise generated on the fly.
Definition at line 80 of file cachingSkyMap.py.
|
inherited |
Definition at line 208 of file baseSkyMap.py.
def lsst.skymap.cachingSkyMap.CachingSkyMap.__iter__ | ( | self | ) |
Iterator over tracts.
Definition at line 71 of file cachingSkyMap.py.
def lsst.skymap.cachingSkyMap.CachingSkyMap.__len__ | ( | self | ) |
Length is number of tracts.
Definition at line 76 of file cachingSkyMap.py.
|
inherited |
Definition at line 217 of file baseSkyMap.py.
def lsst.skymap.cachingSkyMap.CachingSkyMap.__reduce__ | ( | self | ) |
To support pickling. Notes ----- **Warning:** This method assumes that the constructor is be defined: __init__(self, config, version=defaultVersion) The use of 'config' is effectively set by the registry mechanism. If additional optional arguments are added, this method should be overridden to correspond.
Definition at line 58 of file cachingSkyMap.py.
|
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 176 of file baseSkyMap.py.
|
inherited |
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.
Definition at line 115 of file baseSkyMap.py.
|
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).
Definition at line 148 of file baseSkyMap.py.
def lsst.skymap.cachingSkyMap.CachingSkyMap.generateTract | ( | self, | |
index | |||
) |
Generate TractInfo for the specified tract index.
Definition at line 94 of file cachingSkyMap.py.
|
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 220 of file baseSkyMap.py.
|
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 268 of file baseSkyMap.py.
|
inherited |
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` .
Definition at line 251 of file baseSkyMap.py.
|
inherited |
Definition at line 106 of file baseSkyMap.py.
|
staticinherited |
Definition at line 100 of file baseSkyMap.py.