lsst.obs.base
19.0.0-51-gb87bce2
|
Public Member Functions | |
def | __init__ (self, List[KeyHandler] handlers, Optional[BaseSkyMap] skyMap, Optional[str] skyMapName, str datasetTypeName) |
def | __str__ (self) |
def | addRule (cls, KeyHandler handler, Optional[str] instrument=None, Optional[str] datasetTypeName=None, Iterable[str] gen2keys=(), bool consume=True) |
def | makeMatching (cls, str datasetTypeName, Dict[str, type] gen2keys, Optional[str] instrument=None, Optional[BaseSkyMap] skyMap=None, Optional[str] skyMapName=None) |
def | __call__ (self, Dict[str, Any] gen2id, *bool partial=False, Optional[Log] log=None) |
def | dimensionNames (self) |
Public Attributes | |
handlers | |
skyMap | |
skyMapName | |
datasetTypeName | |
Callable object that translates Gen2 Data IDs to Gen3 Data IDs for a particular DatasetType. Translators should usually be constructed via the `makeMatching` method. Parameters ---------- handlers : `list` A list of KeyHandlers this Translator should use. skyMap : `BaseSkyMap`, optional SkyMap instance used to define any tract or patch Dimensions. skyMapName : `str` Gen3 SkyMap Dimension name to be associated with any tract or patch Dimensions. datasetTypeName : `str` Name of the dataset type whose data IDs this translator handles.
Definition at line 279 of file translators.py.
def lsst.obs.base.gen2to3.translators.Translator.__init__ | ( | self, | |
List[KeyHandler] | handlers, | ||
Optional[BaseSkyMap] | skyMap, | ||
Optional[str] | skyMapName, | ||
str | datasetTypeName | ||
) |
Definition at line 297 of file translators.py.
def lsst.obs.base.gen2to3.translators.Translator.__call__ | ( | self, | |
Dict[str, Any] | gen2id, | ||
*bool | partial = False , |
||
Optional[Log] | log = None |
||
) |
Return a Gen3 data ID that corresponds to the given Gen2 data ID.
Definition at line 414 of file translators.py.
def lsst.obs.base.gen2to3.translators.Translator.__str__ | ( | self | ) |
Definition at line 322 of file translators.py.
def lsst.obs.base.gen2to3.translators.Translator.addRule | ( | cls, | |
KeyHandler | handler, | ||
Optional[str] | instrument = None , |
||
Optional[str] | datasetTypeName = None , |
||
Iterable[str] | gen2keys = () , |
||
bool | consume = True |
||
) |
Add a KeyHandler and an associated matching rule. Parameters ---------- handler : `KeyHandler` A KeyHandler instance to add to a Translator when this rule matches. instrument : `str` Gen3 instrument name the Gen2 repository must be associated with for this rule to match, or None to match any instrument. datasetTypeName : `str` Name of the DatasetType this rule matches, or None to match any DatasetType. gen2Keys : sequence Sequence of Gen2 data ID keys that must all be present for this rule to match. consume : `bool` or `tuple` If True (default), remove all entries in gen2keys from the set of keys being matched to in order to prevent less-specific handlers from matching them. May also be a `tuple` listing only the keys to consume.
Definition at line 327 of file translators.py.
def lsst.obs.base.gen2to3.translators.Translator.dimensionNames | ( | self | ) |
The names of the dimensions populated by this Translator (`frozenset`).
Definition at line 432 of file translators.py.
def lsst.obs.base.gen2to3.translators.Translator.makeMatching | ( | cls, | |
str | datasetTypeName, | ||
Dict[str, type] | gen2keys, | ||
Optional[str] | instrument = None , |
||
Optional[BaseSkyMap] | skyMap = None , |
||
Optional[str] | skyMapName = None |
||
) |
Construct a Translator appropriate for instances of the given dataset. Parameters ---------- datasetTypeName : `str` Name of the dataset type. gen2keys: `dict` Keys of a Gen2 data ID for this dataset. instrument: `str`, optional Name of the Gen3 instrument dimension for translated data IDs. skyMap: `~lsst.skymap.BaseSkyMap`, optional The skymap instance that defines any tract/patch data IDs. `~lsst.skymap.BaseSkyMap` instances. skyMapName : `str`, optional Gen3 SkyMap Dimension name to be associated with any tract or patch Dimensions. Returns ------- translator : `Translator` A translator whose translate() method can be used to transform Gen2 data IDs to Gen3 dataIds.
Definition at line 368 of file translators.py.
lsst.obs.base.gen2to3.translators.Translator.datasetTypeName |
Definition at line 301 of file translators.py.
lsst.obs.base.gen2to3.translators.Translator.handlers |
Definition at line 298 of file translators.py.
lsst.obs.base.gen2to3.translators.Translator.skyMap |
Definition at line 299 of file translators.py.
lsst.obs.base.gen2to3.translators.Translator.skyMapName |
Definition at line 300 of file translators.py.