lsst.obs.base  17.0.1-20-gbbf9965+2
Public Member Functions | Public Attributes | List of all members
lsst.obs.base.gen3.repoConverter.DataIdExtractor Class Reference

Public Member Functions

def __init__ (self, datasetTypeName, storageClass, universe, baseDataId, filePathParser=None, translator=None, mapper=None, skyMap=None)
 
def apply (self, fileNameInRoot)
 

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.
baseDataId : `dict`
    Key-value pairs that may need to appear in the Gen3 data ID, but can
    never be inferred from a Gen2 filename.  This should always include
    the instrument name (even Gen3 data IDs that don't involve the
    instrument dimension have instrument-dependent Gen2 filenames) and
    should also include the skymap name for any data ID that involves
    tracts or patches.
filePathParser : `lsst.daf.butler.gen2convert.FilePathParser`, optional
    Object responsible for reading a Gen2 data ID from a filename.  Will
    be created from ``mapper`` if not provided.
translator : `lsst.daf.butler.gen2convert.Translator`, optional
    Object responsible for converting a Gen2 data ID into a Gen3 data ID.
    Will be created if not provided.
mapper : `lsst.obs.base.CameraMapper`, optional
    Object that defines Gen2 filename templates.  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.

Definition at line 78 of file repoConverter.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.obs.base.gen3.repoConverter.DataIdExtractor.__init__ (   self,
  datasetTypeName,
  storageClass,
  universe,
  baseDataId,
  filePathParser = None,
  translator = None,
  mapper = None,
  skyMap = None 
)

Definition at line 112 of file repoConverter.py.

Member Function Documentation

◆ apply()

def lsst.obs.base.gen3.repoConverter.DataIdExtractor.apply (   self,
  fileNameInRoot 
)
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.DataId` or `None`
    The Gen3 data ID, or `None` if the file was not recognized as an
    instance of the extractor's dataset type.

Definition at line 122 of file repoConverter.py.

Member Data Documentation

◆ datasetType

lsst.obs.base.gen3.repoConverter.DataIdExtractor.datasetType

Definition at line 119 of file repoConverter.py.

◆ filePathParser

lsst.obs.base.gen3.repoConverter.DataIdExtractor.filePathParser

Definition at line 115 of file repoConverter.py.

◆ translator

lsst.obs.base.gen3.repoConverter.DataIdExtractor.translator

Definition at line 118 of file repoConverter.py.


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