LSSTApplications  19.0.0-14-gb0260a2+6db932c395,20.0.0+235c3eae2c,20.0.0+448775ce90,20.0.0+5f56aa8f28,20.0.0+b40eaeb6a0,20.0.0+d006f05c5d,20.0.0+dbd2281351,20.0.0+dc1acf7baf,20.0.0+e2e26847c2,20.0.0+f48bb53858,20.0.0-1-g10df615+4b67200b40,20.0.0-1-g253301a+d006f05c5d,20.0.0-1-g2b7511a+f48bb53858,20.0.0-1-g4d801e7+68c50072dc,20.0.0-1-g5b95a8c+d1beabf16b,20.0.0-1-g660595b+f45b7d88f4,20.0.0-1-gc96f8cb+4df7bab894,20.0.0-1-gd1c87d7+add1f556b4,20.0.0-1-gedffbd8+eb23c4e4f2,20.0.0-11-g13aeee2+1a7c0f1887,20.0.0-14-g199c894+e853f797a7,20.0.0-15-gf5872d0+4df7bab894,20.0.0-16-g6fe20a1+b7072f60df,20.0.0-2-g4dae9ad+4df7bab894,20.0.0-2-g5ad0983+1a7c0f1887,20.0.0-2-g7818986+add1f556b4,20.0.0-2-gb095acb+63636aeed8,20.0.0-2-gdaeb0e8+7d7ca508c5,20.0.0-2-gec03fae+de92faa26f,20.0.0-23-g8d4de91b+950b69a445,20.0.0-4-gfea843c+f45b7d88f4,20.0.0-46-g00fa051+1467b54e00,20.0.0-5-g357b56b+f45b7d88f4,20.0.0-5-gfcebe35+a6a1a2f802,20.0.0-7-gc818c6e6+57cf537add,20.0.0-7-gcda7bf1+738fa57269,20.0.0-9-g61a2a9a3d+7fa50e000d,w.2020.38
LSSTDataManagementBasePackage
Public Member Functions | Public Attributes | List of all members
lsst.obs.base.gen2to3.translators.AbstractToPhysicalFilterKeyHandler Class Reference
Inheritance diagram for lsst.obs.base.gen2to3.translators.AbstractToPhysicalFilterKeyHandler:
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 ``abstract_filter``
keys in gen3 but should be mapped to ``physical_filter``.

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

Definition at line 260 of file translators.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 271 of file translators.py.

271  def __init__(self, filterDefinitions):
272  super().__init__("physical_filter")
273  self._map = {d.abstract_filter: d.physical_filter for d in filterDefinitions
274  if d.abstract_filter is not None}
275 

Member Function Documentation

◆ __repr__()

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

Definition at line 81 of file translators.py.

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

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

112  def extract(self, gen2id: dict, skyMap: Optional[BaseSkyMap], skyMapName: Optional[str],
113  datasetTypeName: str) -> Any:
114  """Extract a Gen3 data ID value from a Gen2 data ID.
115 
116  Parameters
117  ----------
118  gen2id: `dict`
119  Gen2 data ID from which to draw key-value pairs from.
120  skyMap: `BaseSkyMap`, optional
121  SkyMap that defines the tracts and patches used in the Gen2 data
122  ID, if any.
123  skyMapName: `str`
124  Name of the Gen3 skymap dimension that defines the tracts and
125  patches used in the Gen3 data ID.
126  datasetTypeName: `str`
127  Name of the dataset type.
128  """
129  raise NotImplementedError()
130 
131 

◆ extract() [2/2]

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

Definition at line 276 of file translators.py.

276  def extract(self, gen2id, *args, **kwargs):
277  abstract = gen2id["filter"]
278  return self._map.get(abstract, abstract)
279 
280 

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

84  def translate(self, gen2id: dict, gen3id: dict,
85  skyMap: Optional[BaseSkyMap], skyMapName: Optional[str],
86  datasetTypeName: str):
87  """Update a Gen3 data ID dict with a single key-value pair from a Gen2
88  data ID.
89 
90  This method is implemented by the base class and is not expected to
91  be re-implemented by subclasses.
92 
93  Parameters
94  ----------
95  gen2id: `dict`
96  Gen2 data ID from which to draw key-value pairs from.
97  gen3id: `dict`
98  Gen3 data ID to update in-place.
99  skyMap: `BaseSkyMap`, optional
100  SkyMap that defines the tracts and patches used in the Gen2 data
101  ID, if any.
102  skyMapName: `str`
103  Name of the Gen3 skymap dimension that defines the tracts and
104  patches used in the Gen3 data ID.
105  datasetTypeName: `str`
106  Name of the dataset type.
107  """
108  gen3id[self.dimension] = self.extract(gen2id, skyMap=skyMap, skyMapName=skyMapName,
109  datasetTypeName=datasetTypeName)
110 

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:
lsst.pex::exceptions.wrappers.translate
def translate(cpp)
Definition: wrappers.py:144