lsst.obs.base  19.0.0-9-ge91d8c4+1
Public Member Functions | Public Attributes | List of all members
lsst.obs.base.gen2to3.dataIdExtractor.DataIdExtractor Class Reference

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.

Member Function Documentation

◆ apply()

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

Definition at line 88 of file dataIdExtractor.py.

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: