lsst.obs.base  20.0.0-24-g0eb5a41+1
Public Member Functions | Public Attributes | List of all members
lsst.obs.base.gen2to3.translators.ConstantKeyHandler Class Reference
Inheritance diagram for lsst.obs.base.gen2to3.translators.ConstantKeyHandler:
lsst.obs.base.gen2to3.translators.KeyHandler

Public Member Functions

def __init__ (self, str dimension, Any value)
 
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

 value
 
 dimension
 

Detailed Description

A KeyHandler that adds a constant key-value pair to the Gen3 data ID.

Parameters
----------
dimension : `str`
    Name of the Gen3 dimension (data ID key) populated by
    this handler (e.g. "visit" or "abstract_filter").
value : `object`
    Data ID value.

Definition at line 132 of file translators.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.obs.base.gen2to3.translators.ConstantKeyHandler.__init__ (   self,
str  dimension,
Any  value 
)

Definition at line 143 of file translators.py.

Member Function Documentation

◆ __repr__()

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

Definition at line 81 of file translators.py.

◆ extract()

Any lsst.obs.base.gen2to3.translators.ConstantKeyHandler.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 149 of file translators.py.

◆ 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.

Member Data Documentation

◆ dimension

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

Definition at line 77 of file translators.py.

◆ value

lsst.obs.base.gen2to3.translators.ConstantKeyHandler.value

Definition at line 145 of file translators.py.


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