lsst.obs.base  19.0.0-6-g315df59
Public Member Functions | Public Attributes | List of all members
lsst.obs.base.gen2to3.calibRepoConverter.CalibRepoConverter Class Reference
Inheritance diagram for lsst.obs.base.gen2to3.calibRepoConverter.CalibRepoConverter:
lsst.obs.base.gen2to3.repoConverter.RepoConverter

Public Member Functions

def __init__
 
def isDatasetTypeSpecial
 
def isDirectorySpecial
 
def iterMappings (self)
 
def makeDataIdExtractor
 
def insertDimensionData (self)
 
def ingest (self)
 
def iterDatasets (self)
 
def prep (self)
 
def getButler
 

Public Attributes

 mapper
 
 task
 
 root
 
 subset
 

Detailed Description

A specialization of `RepoConverter` for calibration repositories.

Parameters
----------
mapper : `CameraMapper`
    Gen2 mapper for the data repository.  The root associated with the
    mapper is ignored and need not match the root of the repository.
kwds
    Additional keyword arguments are forwarded to (and required by)
    `RepoConverter`.

Definition at line 51 of file calibRepoConverter.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.obs.base.gen2to3.calibRepoConverter.CalibRepoConverter.__init__ (   self,
  mapper 
)

Definition at line 64 of file calibRepoConverter.py.

Member Function Documentation

◆ getButler()

def lsst.obs.base.gen2to3.repoConverter.RepoConverter.getButler (   self,
  datasetTypeName 
)
inherited

Definition at line 475 of file repoConverter.py.

◆ ingest()

def lsst.obs.base.gen2to3.calibRepoConverter.CalibRepoConverter.ingest (   self)

Definition at line 133 of file calibRepoConverter.py.

◆ insertDimensionData()

def lsst.obs.base.gen2to3.calibRepoConverter.CalibRepoConverter.insertDimensionData (   self)

Definition at line 94 of file calibRepoConverter.py.

◆ isDatasetTypeSpecial()

def lsst.obs.base.gen2to3.calibRepoConverter.CalibRepoConverter.isDatasetTypeSpecial (   self,
  datasetTypeName 
)

Definition at line 69 of file calibRepoConverter.py.

◆ isDirectorySpecial()

def lsst.obs.base.gen2to3.calibRepoConverter.CalibRepoConverter.isDirectorySpecial (   self,
  subdirectory 
)

Definition at line 73 of file calibRepoConverter.py.

◆ iterDatasets()

def lsst.obs.base.gen2to3.repoConverter.RepoConverter.iterDatasets (   self,
  Iterator,
  FileDataset 
)
inherited
Iterate over all datasets in the repository that should be
ingested into the Gen3 repository.

Subclasses may override this method, but must delegate to the base
class implementation at some point in their own logic.

Yields
------
dataset : `FileDataset`
    Structures representing datasets to be ingested.  Paths should be
    absolute.
ref : `lsst.daf.butler.DatasetRef`
    Reference for the Gen3 datasets, including a complete `DatasetType`
    and data ID.

Definition at line 347 of file repoConverter.py.

◆ iterMappings()

def lsst.obs.base.gen2to3.calibRepoConverter.CalibRepoConverter.iterMappings (   self,
  Iterator,
  Tuple,
  str,
  CameraMapperMapping 
)

Definition at line 77 of file calibRepoConverter.py.

◆ makeDataIdExtractor()

def lsst.obs.base.gen2to3.calibRepoConverter.CalibRepoConverter.makeDataIdExtractor (   self,
  datasetTypeName 
)

Definition at line 81 of file calibRepoConverter.py.

◆ prep()

def lsst.obs.base.gen2to3.repoConverter.RepoConverter.prep (   self)
inherited
Prepare the repository by identifying the dataset types to be
converted and building `DataIdExtractor` instance for them.

Subclasses may override this method, but must delegate to the base
class implementation at some point in their own logic.  More often,
subclasses will specialize the behavior of `prep` simply by overriding
`iterMappings`, `isDatasetTypeSpecial`, and `makeDataIdExtractor`, to
which the base implementation delegates.

This should not perform any write operations to the Gen3 repository.
It is guaranteed to be called before `insertDimensionData` and
`ingest`.

Definition at line 389 of file repoConverter.py.

Member Data Documentation

◆ mapper

lsst.obs.base.gen2to3.calibRepoConverter.CalibRepoConverter.mapper

Definition at line 66 of file calibRepoConverter.py.

◆ root

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

Definition at line 254 of file repoConverter.py.

◆ subset

lsst.obs.base.gen2to3.repoConverter.RepoConverter.subset
inherited

Definition at line 255 of file repoConverter.py.

◆ task

lsst.obs.base.gen2to3.repoConverter.RepoConverter.task
inherited

Definition at line 253 of file repoConverter.py.


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