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

Inheritance diagram for lsst.obs.base.gen2to3.translators.CalibKeyHandler:

Public Member Functions
def	__init__ (self, ccdKey="ccd")
Any	extract (self, dict gen2id, Optional[BaseSkyMap] skyMap, Optional[str] skyMapName, str datasetTypeName)
def	__repr__ (self)
def	translate (self, dict gen2id, dict gen3id, Optional[BaseSkyMap] skyMap, Optional[str] skyMapName, str datasetTypeName)

Public Attributes
	ccdKey
	dimension

Detailed Description

A KeyHandler for master calibration datasets.

Definition at line 223 of file translators.py.

Constructor & Destructor Documentation

__init__()

def lsst.obs.base.gen2to3.translators.CalibKeyHandler.__init__	(		self,
			ccdKey = "ccd"
	)

Definition at line 228 of file translators.py.

    def __init__(self, ccdKey="ccd"):
        self.ccdKey = ccdKey
        super().__init__("calibration_label")
 

Member Function Documentation

__repr__()

def lsst.obs.base.gen2to3.translators.KeyHandler.__repr__ (   self )

inherited

Definition at line 81 of file translators.py.

    def __repr__(self):
        return f"{type(self).__name__}({self.dimension}, ...)"
 

extract()

Any lsst.obs.base.gen2to3.translators.CalibKeyHandler.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 from lsst.obs.base.gen2to3.translators.KeyHandler.

Definition at line 232 of file translators.py.

    def extract(self, gen2id: dict, skyMap: Optional[BaseSkyMap], skyMapName: Optional[str],
                datasetTypeName: str) -> Any:
        # Docstring inherited from KeyHandler.extract.
        return makeCalibrationLabel(datasetTypeName, gen2id["calibDate"],
                                    ccd=gen2id.get(self.ccdKey), filter=gen2id.get("filter"))
 
 

translate()

def lsst.obs.base.gen2to3.translators.KeyHandler.translate (   self, dict  gen2id, dict  gen3id, Optional[BaseSkyMap]  skyMap, Optional[str]  skyMapName, str  datasetTypeName  )

inherited

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

    def translate(self, gen2id: dict, gen3id: dict,
                  skyMap: Optional[BaseSkyMap], skyMapName: Optional[str],
                  datasetTypeName: str):
        """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.
        """
        gen3id[self.dimension] = self.extract(gen2id, skyMap=skyMap, skyMapName=skyMapName,
                                              datasetTypeName=datasetTypeName)
 

Member Data Documentation

ccdKey

lsst.obs.base.gen2to3.translators.CalibKeyHandler.ccdKey

Definition at line 229 of file translators.py.

dimension

lsst.obs.base.gen2to3.translators.KeyHandler.dimension

inherited

Definition at line 77 of file translators.py.

---

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

• /j/snowflake/release/lsstsw/stack/cb4e2dc/Linux64/obs_base/20.0.0-47-g0830830+f5f993f8be/python/lsst/obs/base/gen2to3/translators.py