|
lsst.obs.base
20.0.0-69-g8f355a9+701c885a11
|
Public Member Functions | |
| def | __init__ (self, str dimension) |
| def | __repr__ (self) |
| def | translate (self, dict gen2id, dict gen3id, Optional[BaseSkyMap] skyMap, Optional[str] skyMapName, str datasetTypeName) |
| Any | extract (self, dict gen2id, Optional[BaseSkyMap] skyMap, Optional[str] skyMapName, str datasetTypeName) |
Public Attributes | |
| dimension | |
Base class for Translator helpers that each handle just one Gen3 Data
ID key.
Parameters
----------
dimension : `str`
Name of the Gen3 dimension (data ID key) populated by
this handler (e.g. "visit" or "band").
Definition at line 35 of file translators.py.
| def lsst.obs.base.gen2to3.translators.KeyHandler.__init__ | ( | self, | |
| str | dimension | ||
| ) |
Definition at line 45 of file translators.py.
| def lsst.obs.base.gen2to3.translators.KeyHandler.__repr__ | ( | self | ) |
Definition at line 50 of file translators.py.
| Any lsst.obs.base.gen2to3.translators.KeyHandler.extract | ( | self, | |
| dict | gen2id, | ||
| Optional[BaseSkyMap] | skyMap, | ||
| Optional[str] | skyMapName, | ||
| str | datasetTypeName | ||
| ) |
Extract a Gen3 data ID value from a Gen2 data ID.
Parameters
----------
gen2id: `dict`
Gen2 data ID from which to draw key-value pairs from.
skyMap: `BaseSkyMap`, optional
SkyMap that defines the tracts and patches used in the Gen2 data
ID, if any.
skyMapName: `str`
Name of the Gen3 skymap dimension that defines the tracts and
patches used in the Gen3 data ID.
datasetTypeName: `str`
Name of the dataset type.
Reimplemented in lsst.obs.base.gen2to3.translators.SkyMapKeyHandler, lsst.obs.base.gen2to3.translators.PatchKeyHandler, lsst.obs.base.gen2to3.translators.CopyKeyHandler, and lsst.obs.base.gen2to3.translators.ConstantKeyHandler.
Definition at line 81 of file translators.py.
| def lsst.obs.base.gen2to3.translators.KeyHandler.translate | ( | self, | |
| dict | gen2id, | ||
| dict | gen3id, | ||
| Optional[BaseSkyMap] | skyMap, | ||
| Optional[str] | skyMapName, | ||
| str | datasetTypeName | ||
| ) |
Update a Gen3 data ID dict with a single key-value pair from a Gen2
data ID.
This method is implemented by the base class and is not expected to
be re-implemented by subclasses.
Parameters
----------
gen2id: `dict`
Gen2 data ID from which to draw key-value pairs from.
gen3id: `dict`
Gen3 data ID to update in-place.
skyMap: `BaseSkyMap`, optional
SkyMap that defines the tracts and patches used in the Gen2 data
ID, if any.
skyMapName: `str`
Name of the Gen3 skymap dimension that defines the tracts and
patches used in the Gen3 data ID.
datasetTypeName: `str`
Name of the dataset type.
Definition at line 53 of file translators.py.
| lsst.obs.base.gen2to3.translators.KeyHandler.dimension |
Definition at line 46 of file translators.py.
1.8.18