lsst.obs.base  17.0.1-16-g7179f55+1
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.obs.base.gen3.calibRepoConverter.CalibRepoConverter Class Reference
Inheritance diagram for lsst.obs.base.gen3.calibRepoConverter.CalibRepoConverter:
lsst.obs.base.gen3.repoConverter.RepoConverter

Public Member Functions

def __init__ (self, root, universe, baseDataId, mapper=None)
 
def addDatasetType (self, datasetTypeName, storageClass)
 
def convertRepo (self, butler, directory=None, transfer=None, formatter=None, skipDirs=())
 
def extractDatasetRef (self, fileNameInRoot)
 
def walkRepo (self, directory=None, skipDirs=())
 

Public Attributes

 db
 
 dimensionEntries
 
 baseDataId
 
 root
 
 mapper
 
 universe
 
 extractors
 
 skyMap
 

Static Public Attributes

tuple COADD_NAMES = ("deep", "goodSeeing", "dcr")
 
tuple REPO_ROOT_FILES
 

Detailed Description

A helper class that ingests (some of) the contents of a Gen2 calibration
data repository into a Gen3 data repository.

This class must be used instead of the base `RepoConverter` to process
dataset types that are associated with validity ranges.

Parameters
----------
root : `str`
    Root of the Gen2 data repository.
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).
mapper : `lsst.obs.base.CameraMapper`, optional
    Object that defines Gen2 filename templates.  Will be identified,
    imported, and constructed from ``root`` if not provided.

Definition at line 32 of file calibRepoConverter.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.obs.base.gen3.calibRepoConverter.CalibRepoConverter.__init__ (   self,
  root,
  universe,
  baseDataId,
  mapper = None 
)

Definition at line 55 of file calibRepoConverter.py.

Member Function Documentation

◆ addDatasetType()

def lsst.obs.base.gen3.calibRepoConverter.CalibRepoConverter.addDatasetType (   self,
  datasetTypeName,
  storageClass 
)

Definition at line 62 of file calibRepoConverter.py.

◆ convertRepo()

def lsst.obs.base.gen3.calibRepoConverter.CalibRepoConverter.convertRepo (   self,
  butler,
  directory = None,
  transfer = None,
  formatter = None,
  skipDirs = () 
)

Definition at line 88 of file calibRepoConverter.py.

◆ extractDatasetRef()

def lsst.obs.base.gen3.repoConverter.RepoConverter.extractDatasetRef (   self,
  fileNameInRoot 
)
inherited
Extract a Gen3 `~lsst.daf.butler.DatasetRef` from a filename in a
Gen2 data repository.

Parameters
----------
fileNameInRoot : `str`
    Name of the file, relative to the root of its Gen2 repository.

Return
------
ref : `lsst.daf.butler.DatasetRef` or `None`
    Reference to the Gen3 dataset that would be created by converting
    this file, or `None` if the file is not recognized as an instance
    of a dataset type known to this converter.

Definition at line 224 of file repoConverter.py.

◆ walkRepo()

def lsst.obs.base.gen3.repoConverter.RepoConverter.walkRepo (   self,
  directory = None,
  skipDirs = () 
)
inherited
Recursively a (subset of) a Gen2 data repository, yielding files
that may be convertible.

Parameters
----------
directory : `str`, optional
    A subdirectory of the repository root to process, instead of
    processing the entire repository.
skipDirs : sequence of `str`
    Subdirectories that should be skipped.

Yields
------
fileNameInRoot : `str`
    Name of a file in the repository, relative to the root of the
    repository.

Definition at line 250 of file repoConverter.py.

Member Data Documentation

◆ baseDataId

lsst.obs.base.gen3.calibRepoConverter.CalibRepoConverter.baseDataId

Definition at line 60 of file calibRepoConverter.py.

◆ COADD_NAMES

tuple lsst.obs.base.gen3.repoConverter.RepoConverter.COADD_NAMES = ("deep", "goodSeeing", "dcr")
staticinherited

Definition at line 168 of file repoConverter.py.

◆ db

lsst.obs.base.gen3.calibRepoConverter.CalibRepoConverter.db

Definition at line 57 of file calibRepoConverter.py.

◆ dimensionEntries

lsst.obs.base.gen3.calibRepoConverter.CalibRepoConverter.dimensionEntries

Definition at line 59 of file calibRepoConverter.py.

◆ extractors

lsst.obs.base.gen3.repoConverter.RepoConverter.extractors
inherited

Definition at line 186 of file repoConverter.py.

◆ mapper

lsst.obs.base.gen3.repoConverter.RepoConverter.mapper
inherited

Definition at line 183 of file repoConverter.py.

◆ REPO_ROOT_FILES

tuple lsst.obs.base.gen3.repoConverter.RepoConverter.REPO_ROOT_FILES
staticinherited
Initial value:
= ("registry.sqlite3", "_mapper", "repositoryCfg.yaml",
"calibRegistry.sqlite3", "_parent")

Definition at line 169 of file repoConverter.py.

◆ root

lsst.obs.base.gen3.repoConverter.RepoConverter.root
inherited

Definition at line 173 of file repoConverter.py.

◆ skyMap

lsst.obs.base.gen3.repoConverter.RepoConverter.skyMap
inherited

Definition at line 200 of file repoConverter.py.

◆ universe

lsst.obs.base.gen3.repoConverter.RepoConverter.universe
inherited

Definition at line 184 of file repoConverter.py.


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