Public Member Functions
def	__init__

def	apply

Public Attributes
	filePathParser

	translator

	datasetType

Detailed Description

A class that extracts Gen3 data IDs from Gen2 filenames for a
particular dataset type.

Parameters
----------
datasetTypeName : `str`
    Name of the dataset type the object will process.
storageClass : `str` or `lsst.daf.butler.StorageClass`
    Gen3 storage class of the dataset type.
universe : `lsst.daf.butler.DimensionUniverse`
    Object containing all dimension definitions.
instrument : `str`
    Name of the Gen3 instrument for output data IDs that include that
    dimension.
filePathParser : `FilePathParser`, optional
    Object responsible for reading a Gen2 data ID from a filename.  Will
    be created from ``mapper`` if not provided.
translator : `Translator`, optional
    Object responsible for converting a Gen2 data ID into a Gen3 data ID.
    Will be created if not provided.
mapping : `lsst.obs.base.Mapper`, optional
    Object that defines a Gen2 dataset type.  Must be provided if
    ``filePathParser`` is not.
skyMap : `lsst.skymap.BaseSkyMap`, optional
    SkyMap that defines tracts and patches.  Must be provided for datasets
    with a ``patch`` key in their data IDs.
skyMapName: `str`, optional
    Name of the Gen3 skymap for output data IDs that include that
    dimension.

Raises
------
RuntimeError
    Raised if the given mapping has no template.

Definition at line 33 of file dataIdExtractor.py.

Constructor & Destructor Documentation

◆ init()

def lsst.obs.base.gen2to3.dataIdExtractor.DataIdExtractor.__init__	(	self,
		datasetTypeName
	)

Definition at line 70 of file dataIdExtractor.py.

     def __init__(self, datasetTypeName: str, storageClass: Union[str, StorageClass], *,
                  universe: DimensionUniverse,
                  instrument: str,
                  filePathParser: Optional[FilePathParser] = None,
                  translator: Optional[Translator] = None,
                  mapping: Optional[Mapping] = None,
                  skyMap: Optional[BaseSkyMap] = None,
                  skyMapName: Optional[str] = None):
         if filePathParser is None:
             filePathParser = FilePathParser.fromMapping(mapping)
         self.filePathParser = filePathParser
         if translator is None:
             translator = Translator.makeMatching(datasetTypeName, filePathParser.keys,
                                                  instrument=instrument, skyMap=skyMap, skyMapName=skyMapName)
         self.translator = translator
         self.datasetType = DatasetType(datasetTypeName, dimensions=self.translator.dimensionNames,
                                        storageClass=storageClass, universe=universe)
 

Member Function Documentation

◆ apply()

def lsst.obs.base.gen2to3.dataIdExtractor.DataIdExtractor.apply	(	self,
		fileNameInRoot
	)

Definition at line 88 of file dataIdExtractor.py.

     def apply(self, fileNameInRoot: str) -> Optional[DataCoordinate]:
         """Extract a Gen3 data ID from the given filename,
 
         Parameters
         ----------
         fileNameInRoot : `str`
             Filename relative to a Gen2 data repository root.
 
         Returns
         -------
         dataId : `lsst.daf.butler.DataCoordinate` or `None`
             The Gen3 data ID, or `None` if the file was not recognized as an
             instance of the extractor's dataset type.
         """
         gen2id = self.filePathParser(fileNameInRoot)
         if gen2id is None:
             return None
         return DataCoordinate.standardize(self.translator(gen2id), graph=self.datasetType.dimensions)
 

Member Data Documentation

◆ datasetType

lsst.obs.base.gen2to3.dataIdExtractor.DataIdExtractor.datasetType

Definition at line 85 of file dataIdExtractor.py.

◆ filePathParser

lsst.obs.base.gen2to3.dataIdExtractor.DataIdExtractor.filePathParser

Definition at line 80 of file dataIdExtractor.py.

◆ translator

lsst.obs.base.gen2to3.dataIdExtractor.DataIdExtractor.translator

Definition at line 84 of file dataIdExtractor.py.

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

/j/snowflake/release/lsstsw/stack/Linux64/obs_base/19.0.0-15-g85ac9ad/python/lsst/obs/base/gen2to3/dataIdExtractor.py

Public Member Functions

Public Attributes