LSST Applications  21.0.0+75b29a8a7f,21.0.0+e70536a077,21.0.0-1-ga51b5d4+62c747d40b,21.0.0-10-gbfb87ad6+3307648ee3,21.0.0-15-gedb9d5423+47cba9fc36,21.0.0-2-g103fe59+fdf0863a2a,21.0.0-2-g1367e85+d38a93257c,21.0.0-2-g45278ab+e70536a077,21.0.0-2-g5242d73+d38a93257c,21.0.0-2-g7f82c8f+e682ffb718,21.0.0-2-g8dde007+d179fbfa6a,21.0.0-2-g8f08a60+9402881886,21.0.0-2-ga326454+e682ffb718,21.0.0-2-ga63a54e+08647d4b1b,21.0.0-2-gde069b7+26c92b3210,21.0.0-2-gecfae73+0445ed2f95,21.0.0-2-gfc62afb+d38a93257c,21.0.0-27-gbbd0d29+ae871e0f33,21.0.0-28-g5fc5e037+feb0e9397b,21.0.0-3-g21c7a62+f4b9c0ff5c,21.0.0-3-g357aad2+57b0bddf0b,21.0.0-3-g4be5c26+d38a93257c,21.0.0-3-g65f322c+3f454acf5d,21.0.0-3-g7d9da8d+75b29a8a7f,21.0.0-3-gaa929c8+9e4ef6332c,21.0.0-3-ge02ed75+4b120a55c4,21.0.0-4-g3300ddd+e70536a077,21.0.0-4-g591bb35+4b120a55c4,21.0.0-4-gc004bbf+4911b9cd27,21.0.0-4-gccdca77+f94adcd104,21.0.0-4-ge8fba5a+2b3a696ff9,21.0.0-5-gb155db7+2c5429117a,21.0.0-5-gdf36809+637e4641ee,21.0.0-6-g00874e7+c9fd7f7160,21.0.0-6-g4e60332+4b120a55c4,21.0.0-7-gc8ca178+40eb9cf840,21.0.0-8-gfbe0b4b+9e4ef6332c,21.0.0-9-g2fd488a+d83b7cd606,w.2021.05
LSST Data Management Base Package
Public Member Functions | Public Attributes | List of all members
lsst.obs.base.gen2to3.translators.PatchKeyHandler Class Reference
Inheritance diagram for lsst.obs.base.gen2to3.translators.PatchKeyHandler:
lsst.obs.base.gen2to3.translators.KeyHandler

Public Member Functions

def __init__ (self)
 
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

 dimension
 

Detailed Description

A KeyHandler for skymap patches.

Definition at line 161 of file translators.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.obs.base.gen2to3.translators.PatchKeyHandler.__init__ (   self)

Definition at line 164 of file translators.py.

164  def __init__(self):
165  super().__init__("patch")
166 

Member Function Documentation

◆ __repr__()

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

Definition at line 50 of file translators.py.

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

◆ extract()

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

170  datasetTypeName: str) -> Any:
171  # Docstring inherited from KeyHandler.extract.
172  tract = gen2id["tract"]
173  tractInfo = skyMap[tract]
174  x, y = gen2id["patch"].split(",")
175  patchInfo = tractInfo[int(x), int(y)]
176  return tractInfo.getSequentialPatchIndex(patchInfo)
177 
178 

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

55  datasetTypeName: str):
56  """Update a Gen3 data ID dict with a single key-value pair from a Gen2
57  data ID.
58 
59  This method is implemented by the base class and is not expected to
60  be re-implemented by subclasses.
61 
62  Parameters
63  ----------
64  gen2id: `dict`
65  Gen2 data ID from which to draw key-value pairs from.
66  gen3id: `dict`
67  Gen3 data ID to update in-place.
68  skyMap: `BaseSkyMap`, optional
69  SkyMap that defines the tracts and patches used in the Gen2 data
70  ID, if any.
71  skyMapName: `str`
72  Name of the Gen3 skymap dimension that defines the tracts and
73  patches used in the Gen3 data ID.
74  datasetTypeName: `str`
75  Name of the dataset type.
76  """
77  gen3id[self.dimension] = self.extract(gen2id, skyMap=skyMap, skyMapName=skyMapName,
78  datasetTypeName=datasetTypeName)
79 

Member Data Documentation

◆ dimension

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

Definition at line 46 of file translators.py.


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