lsst.obs.base  19.0.0-78-g248c58d
Public Member Functions | Public Attributes | List of all members
lsst.obs.base.gen2to3.translators.PhysicalToAbstractFilterKeyHandler Class Reference
Inheritance diagram for lsst.obs.base.gen2to3.translators.PhysicalToAbstractFilterKeyHandler:
lsst.obs.base.gen2to3.translators.KeyHandler

Public Member Functions

def __init__ (self, filterDefinitions)
 
def extract (self, gen2id, *args, **kwargs)
 
def __repr__ (self)
 
def translate (self, dict gen2id, dict gen3id, Optional[BaseSkyMap] skyMap, Optional[str] skyMapName, str datasetTypeName)
 
Any extract (self, dict gen2id, Optional[BaseSkyMap] skyMap, Optional[str] skyMapName, str datasetTypeName)
 

Public Attributes

 dimension
 

Detailed Description

KeyHandler for gen2 ``filter`` keys that match ``physical_filter``
keys in gen3 but should be mapped to ``abstract_filter``.

Note that multiple physical filter can potentially map to one abstract
filter, so be careful to only use this translator on obs packages where
there is a one-to-one mapping.

Definition at line 239 of file translators.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.obs.base.gen2to3.translators.PhysicalToAbstractFilterKeyHandler.__init__ (   self,
  filterDefinitions 
)

Definition at line 250 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() [1/2]

Any lsst.obs.base.gen2to3.translators.KeyHandler.extract (   self,
dict  gen2id,
Optional[BaseSkyMap]  skyMap,
Optional[str]  skyMapName,
str  datasetTypeName 
)
inherited
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 in lsst.obs.base.gen2to3.translators.CalibKeyHandler, lsst.obs.base.gen2to3.translators.SkyMapKeyHandler, lsst.obs.base.gen2to3.translators.PatchKeyHandler, lsst.obs.base.gen2to3.translators.CopyKeyHandler, and lsst.obs.base.gen2to3.translators.ConstantKeyHandler.

Definition at line 112 of file translators.py.

◆ extract() [2/2]

def lsst.obs.base.gen2to3.translators.PhysicalToAbstractFilterKeyHandler.extract (   self,
  gen2id,
args,
**  kwargs 
)

Definition at line 255 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.


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