LSST Applications
21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
|
Public Member Functions | |
def | __init__ (self, config, version=1) |
def | getRingIndices (self, index) |
def | generateTract (self, index) |
def | findTract (self, coord) |
def | findTractIdArray (self, ra, dec, degrees=False) |
def | findAllTracts (self, coord) |
def | findTractPatchList (self, coordList) |
def | updateSha1 (self, sha1) |
def | __reduce__ (self) |
def | __iter__ (self) |
def | __len__ (self) |
def | __getitem__ (self, index) |
def | findClosestTractPatchList (self, coordList) |
def | __hash__ (self) |
def | __eq__ (self, other) |
def | __ne__ (self, other) |
def | logSkyMapInfo (self, log) |
def | getSha1 (self) |
def | register (self, name, butler) |
Public Attributes | |
config | |
Static Public Attributes | |
ConfigClass = RingsSkyMapConfig | |
string | SKYMAP_RUN_COLLECTION_NAME = "skymaps" |
string | SKYMAP_DATASET_TYPE_NAME = "skyMap" |
Rings sky map pixelization. We divide the sphere into N rings of Declination, plus the two polar caps, which sets the size of the individual tracts. The rings are divided in RA into an integral number of tracts of this size; this division is made at the Declination closest to zero so as to ensure full overlap. Rings are numbered in the rings from south to north. The south pole cap is ``tract=0``, then the tract at ``raStart`` in the southernmost ring is ``tract=1``. Numbering continues (in the positive RA direction) around that ring and then continues in the same fashion with the next ring north, and so on until all reaching the north pole cap, which is ``tract=len(skymap) - 1``. However, ``version=0`` had a bug in the numbering of the tracts: the first and last tracts in the first (southernmost) ring were identical, and the first tract in the last (northernmost) ring was missing. When using ``version=0``, these tracts remain missing in order to preserve the numbering scheme. Parameters ---------- config : `lsst.skymap.RingsSkyMapConfig` The configuration for this SkyMap. version : `int`, optional Software version of this class, to retain compatibility with old verisons. ``version=0`` covers the period from first implementation until DM-14809, at which point bugs were identified in the numbering of tracts (affecting only tracts at RA=0). ``version=1`` uses the post-DM-14809 tract numbering.
Definition at line 42 of file ringsSkyMap.py.
def lsst.skymap.ringsSkyMap.RingsSkyMap.__init__ | ( | self, | |
config, | |||
version = 1 |
|||
) |
Definition at line 78 of file ringsSkyMap.py.
|
inherited |
Definition at line 252 of file baseSkyMap.py.
|
inherited |
Get the TractInfo for a particular index. The tract is returned from a cache, if available, otherwise generated on the fly.
Reimplemented from lsst.skymap.baseSkyMap.BaseSkyMap.
Definition at line 80 of file cachingSkyMap.py.
|
inherited |
Definition at line 249 of file baseSkyMap.py.
|
inherited |
Iterator over tracts.
Reimplemented from lsst.skymap.baseSkyMap.BaseSkyMap.
Definition at line 71 of file cachingSkyMap.py.
|
inherited |
Length is number of tracts.
Reimplemented from lsst.skymap.baseSkyMap.BaseSkyMap.
Definition at line 76 of file cachingSkyMap.py.
|
inherited |
Definition at line 258 of file baseSkyMap.py.
|
inherited |
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.
def lsst.skymap.ringsSkyMap.RingsSkyMap.findAllTracts | ( | self, | |
coord | |||
) |
Find all tracts which include the specified coord. Parameters ---------- coord : `lsst.geom.SpherePoint` ICRS sky coordinate to search for. Returns ------- tractList : `list` of `TractInfo` The tracts which include the specified coord.
Definition at line 252 of file ringsSkyMap.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 217 of file baseSkyMap.py.
def lsst.skymap.ringsSkyMap.RingsSkyMap.findTract | ( | self, | |
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.
Reimplemented from lsst.skymap.baseSkyMap.BaseSkyMap.
Definition at line 187 of file ringsSkyMap.py.
def lsst.skymap.ringsSkyMap.RingsSkyMap.findTractIdArray | ( | self, | |
ra, | |||
dec, | |||
degrees = False |
|||
) |
Find array of tract IDs with vectorized operations (where supported). If a given sky map does not support vectorized operations, then a loop over findTract will be called. Parameters ---------- ra : `np.ndarray` Array of Right Ascension. Units are radians unless degrees=True. dec : `np.ndarray` Array of Declination. Units are radians unless degrees=True. degrees : `bool`, optional Input ra, dec arrays are degrees if True. Returns ------- tractId : `np.ndarray` Array of tract IDs Notes ----- - If coord is equidistant between multiple sky tract centers then one is arbitrarily chosen. **Warning:** If tracts do not cover the whole sky then the returned tract may not include the given ra/dec.
Reimplemented from lsst.skymap.baseSkyMap.BaseSkyMap.
Definition at line 205 of file ringsSkyMap.py.
def lsst.skymap.ringsSkyMap.RingsSkyMap.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).
Reimplemented from lsst.skymap.baseSkyMap.BaseSkyMap.
Definition at line 303 of file ringsSkyMap.py.
def lsst.skymap.ringsSkyMap.RingsSkyMap.generateTract | ( | self, | |
index | |||
) |
Generate TractInfo for the specified tract index.
Reimplemented from lsst.skymap.cachingSkyMap.CachingSkyMap.
Definition at line 124 of file ringsSkyMap.py.
def lsst.skymap.ringsSkyMap.RingsSkyMap.getRingIndices | ( | self, | |
index | |||
) |
Calculate ring indices given a numerical index of a tract. The ring indices are the ring number and the tract number within the ring. The ring number is -1 for the south polar cap and increases to the north. The north polar cap has ring number = numRings. The tract number is zero for either of the polar caps.
Definition at line 93 of file ringsSkyMap.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 285 of file baseSkyMap.py.
|
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 261 of file baseSkyMap.py.
|
inherited |
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.
Definition at line 337 of file baseSkyMap.py.
def lsst.skymap.ringsSkyMap.RingsSkyMap.updateSha1 | ( | self, | |
sha1 | |||
) |
Add subclass-specific state or configuration options to the SHA1.
Reimplemented from lsst.skymap.baseSkyMap.BaseSkyMap.
Definition at line 312 of file ringsSkyMap.py.
|
inherited |
Definition at line 108 of file baseSkyMap.py.
|
static |
Definition at line 75 of file ringsSkyMap.py.
|
staticinherited |
Definition at line 335 of file baseSkyMap.py.
|
staticinherited |
Definition at line 333 of file baseSkyMap.py.