lsst.obs.base.gen2to3.translators.Translator Class Reference

Public Member Functions
def	__init__ (self, List[KeyHandler] handlers, Optional[BaseSkyMap] skyMap, Optional[str] skyMapName, str datasetTypeName, Log log)
def	__str__ (self)
Tuple[dict, Optional[str]]	__call__ (self, Dict[str, Any] gen2id, *bool partial=False)
FrozenSet[str]	dimensionNames (self)

Public Attributes
	handlers
	skyMap
	skyMapName
	datasetTypeName
	log

Detailed Description

Callable object that translates Gen2 Data IDs to Gen3 Data IDs for a
particular DatasetType.

Translators should usually be constructed via
`TranslatorFactory.makeMatching`.

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 472 of file translators.py.

Constructor & Destructor Documentation

__init__()

def lsst.obs.base.gen2to3.translators.Translator.__init__	(		self,
		List[KeyHandler]	handlers,
		Optional[BaseSkyMap]	skyMap,
		Optional[str]	skyMapName,
		str	datasetTypeName,
		Log	log
	)

Definition at line 491 of file translators.py.

                 datasetTypeName: str, log: Log):
        self.handlers = handlers
        self.skyMap = skyMap
        self.skyMapName = skyMapName
        self.datasetTypeName = datasetTypeName
        self.log = log
 

Member Function Documentation

__call__()

Tuple[dict, Optional[str]] lsst.obs.base.gen2to3.translators.Translator.__call__	(		self,
		Dict[str, Any]	gen2id,
		*bool	partial = False
	)

Return a Gen3 data ID that corresponds to the given Gen2 data ID.

Definition at line 505 of file translators.py.

    def __call__(self, gen2id: Dict[str, Any], *, partial: bool = False) -> Tuple[dict, Optional[str]]:
        """Return a Gen3 data ID that corresponds to the given Gen2 data ID.
        """
        gen3id = {}
        calibDate = gen2id.get("calibDate", None)
        for handler in self.handlers:
            try:
                handler.translate(gen2id, gen3id, skyMap=self.skyMap, skyMapName=self.skyMapName,
                                  datasetTypeName=self.datasetTypeName)
            except KeyError:
                if partial:
                    self.log.debug("Failed to translate %s from %s (this may not be an error).",
                                   handler.dimension, gen2id)
                    continue
                else:
                    raise
        return gen3id, calibDate
 

__str__()

def lsst.obs.base.gen2to3.translators.Translator.__str__

(

self

)

Definition at line 501 of file translators.py.

    def __str__(self):
        hstr = ",".join(str(h) for h in self.handlers)
        return f"{type(self).__name__}(dtype={self.datasetTypeName}, handlers=[{hstr}])"
 

dimensionNames()

FrozenSet[str] lsst.obs.base.gen2to3.translators.Translator.dimensionNames

(

self

)

The names of the dimensions populated by this Translator
(`frozenset`).

Definition at line 524 of file translators.py.

    def dimensionNames(self) -> FrozenSet[str]:
        """The names of the dimensions populated by this Translator
        (`frozenset`).
        """
        return frozenset(h.dimension for h in self.handlers)

Member Data Documentation

datasetTypeName

lsst.obs.base.gen2to3.translators.Translator.datasetTypeName

Definition at line 496 of file translators.py.

handlers

lsst.obs.base.gen2to3.translators.Translator.handlers

Definition at line 493 of file translators.py.

log

lsst.obs.base.gen2to3.translators.Translator.log

Definition at line 497 of file translators.py.

skyMap

lsst.obs.base.gen2to3.translators.Translator.skyMap

Definition at line 494 of file translators.py.

skyMapName

lsst.obs.base.gen2to3.translators.Translator.skyMapName

Definition at line 495 of file translators.py.

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/0.2.1/Linux64/obs_base/21.0.0-27-gbbd0d29+ae871e0f33/python/lsst/obs/base/gen2to3/translators.py