lsst.obs.base  20.0.0-17-g41c5faf
Public Member Functions | Public Attributes | List of all members
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)
 
def __call__ (self, Dict[str, Any] gen2id, *bool partial=False)
 
def 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 526 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 545 of file translators.py.

Member Function Documentation

◆ __call__()

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

◆ __str__()

def lsst.obs.base.gen2to3.translators.Translator.__str__ (   self)

Definition at line 555 of file translators.py.

◆ dimensionNames()

def lsst.obs.base.gen2to3.translators.Translator.dimensionNames (   self)
The names of the dimensions populated by this Translator
(`frozenset`).

Definition at line 577 of file translators.py.

Member Data Documentation

◆ datasetTypeName

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

Definition at line 549 of file translators.py.

◆ handlers

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

Definition at line 546 of file translators.py.

◆ log

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

Definition at line 550 of file translators.py.

◆ skyMap

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

Definition at line 547 of file translators.py.

◆ skyMapName

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

Definition at line 548 of file translators.py.


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