lsst.obs.base  19.0.0-43-gbcf6a3c
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 iterMappings (self)
 
def makeRepoWalkerTarget
 
def insertDimensionData (self)
 
def ingest (self)
 
def getSpecialDirectories (self)
 
def prep (self)
 
def iterDatasets (self)
 
def findDatasets (self)
 
def expandDataIds (self)
 
def getRun
 

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 43 of file calibRepoConverter.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 56 of file calibRepoConverter.py.

Member Function Documentation

◆ expandDataIds()

def lsst.obs.base.gen2to3.repoConverter.RepoConverter.expandDataIds (   self)
inherited
Expand the data IDs for all datasets to be inserted.

Subclasses may override this method, but must delegate to the base
class implementation if they do.

This involves queries to the registry, but not writes.  It is
guaranteed to be called between `insertDimensionData` and `ingest`.

Definition at line 446 of file repoConverter.py.

◆ findDatasets()

def lsst.obs.base.gen2to3.repoConverter.RepoConverter.findDatasets (   self)
inherited

Definition at line 415 of file repoConverter.py.

◆ getRun()

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

Definition at line 498 of file repoConverter.py.

◆ getSpecialDirectories()

def lsst.obs.base.gen2to3.repoConverter.RepoConverter.getSpecialDirectories (   self,
  List,
  str 
)
inherited
Return a list of directory paths that should not be searched for
files.

These may be directories that simply do not contain datasets (or
contain datasets in another repository), or directories whose datasets
are handled specially by a subclass.

Returns
-------
directories : `list` [`str`]
    The full paths of directories to skip, relative to the repository
    root.

Definition at line 286 of file repoConverter.py.

◆ ingest()

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

Definition at line 141 of file calibRepoConverter.py.

◆ insertDimensionData()

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

Definition at line 87 of file calibRepoConverter.py.

◆ isDatasetTypeSpecial()

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

Definition at line 61 of file calibRepoConverter.py.

◆ iterDatasets()

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

The base class implementation yields nothing; the datasets handled by
the `RepoConverter` base class itself are read directly in
`findDatasets`.

Subclasses should override this method if they support additional
datasets that are handled some other way.

Yields
------
dataset : `FileDataset`
    Structures representing datasets to be ingested.  Paths should be
    absolute.

Definition at line 396 of file repoConverter.py.

◆ iterMappings()

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

Definition at line 65 of file calibRepoConverter.py.

◆ makeRepoWalkerTarget()

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

Definition at line 69 of file calibRepoConverter.py.

◆ prep()

def lsst.obs.base.gen2to3.repoConverter.RepoConverter.prep (   self)
inherited
Perform preparatory work associated with the dataset types to be
converted from this repository (but not the datasets themselves).

Notes
-----
This should be a relatively fast operation that should not depend on
the size of the repository.

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` by
overriding other methods to which the base class implementation
delegates.  These include:
 - `iterMappings`
 - `isDatasetTypeSpecial`
 - `getSpecialDirectories`
 - `makeRepoWalkerTarget`

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

Definition at line 302 of file repoConverter.py.

Member Data Documentation

◆ mapper

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

Definition at line 58 of file calibRepoConverter.py.

◆ root

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

Definition at line 208 of file repoConverter.py.

◆ subset

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

Definition at line 209 of file repoConverter.py.

◆ task

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

Definition at line 207 of file repoConverter.py.


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