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

Public Member Functions
def	__init__
def	addRule
def	makeMatching
def	__call__ (self, gen2id)
def	dimensionNames (self)

Public Attributes
	handlers
	skyMap
	skyMapName
	datasetTypeName

Detailed Description

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

Constructor & Destructor Documentation

__init__()

def lsst.obs.base.gen2to3.translators.Translator.__init__	(		self,
			handlers
	)

Definition at line 247 of file translators.py.

Member Function Documentation

__call__()

def lsst.obs.base.gen2to3.translators.Translator.__call__	(		self,
			gen2id
	)

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

Definition at line 360 of file translators.py.

addRule()

def lsst.obs.base.gen2to3.translators.Translator.addRule	(		cls,
			handler
	)

Definition at line 273 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 370 of file translators.py.

makeMatching()

def lsst.obs.base.gen2to3.translators.Translator.makeMatching	(		cls,
			datasetTypeName
	)

Definition at line 314 of file translators.py.

Member Data Documentation

datasetTypeName

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

Definition at line 252 of file translators.py.

handlers

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

Definition at line 249 of file translators.py.

skyMap

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

Definition at line 250 of file translators.py.

skyMapName

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

Definition at line 251 of file translators.py.

---

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

• python/lsst/obs/base/gen2to3/translators.py