lsst.obs.base  19.0.0-18-g955d782+3
Public Member Functions | Public Attributes | List of all members
lsst.obs.base.gen2to3.standardRepoConverter.StandardRepoConverter Class Reference
Inheritance diagram for lsst.obs.base.gen2to3.standardRepoConverter.StandardRepoConverter:
lsst.obs.base.gen2to3.repoConverter.RepoConverter lsst.obs.base.gen2to3.rootRepoConverter.RootRepoConverter

Public Member Functions

def __init__ (self, kwds)
 
def isDatasetTypeSpecial
 
def prep (self)
 
def iterMappings (self)
 
def findMatchingSkyMap
 
def makeRepoWalkerTarget
 
def iterDatasets (self)
 
def getSpecialDirectories (self)
 
def findDatasets (self)
 
def insertDimensionData (self)
 
def handleDataIdExpansionFailure
 
def expandDataIds (self)
 
def ingest (self)
 
def getButler
 

Public Attributes

 butler2
 
 mapper
 
 task
 
 root
 
 subset
 

Detailed Description

A specialization of `RepoConverter` for non-calibration repositories.

Parameters
----------
kwds
    Keyword arguments are forwarded to (and required by) `RepoConverter`.

Definition at line 76 of file standardRepoConverter.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.obs.base.gen2to3.standardRepoConverter.StandardRepoConverter.__init__ (   self,
  kwds 
)

Definition at line 85 of file standardRepoConverter.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.  If they wish to handle expected
failures in data ID expansion, they should override
`handleDataIdExpansionFailure` instead.

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

Definition at line 428 of file repoConverter.py.

◆ findDatasets()

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

Definition at line 393 of file repoConverter.py.

◆ findMatchingSkyMap()

def lsst.obs.base.gen2to3.standardRepoConverter.StandardRepoConverter.findMatchingSkyMap (   self,
  datasetTypeName 
)

Definition at line 129 of file standardRepoConverter.py.

◆ getButler()

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

Definition at line 478 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 277 of file repoConverter.py.

◆ handleDataIdExpansionFailure()

def lsst.obs.base.gen2to3.repoConverter.RepoConverter.handleDataIdExpansionFailure (   self,
  dataset 
)
inherited

Definition at line 424 of file repoConverter.py.

◆ ingest()

def lsst.obs.base.gen2to3.repoConverter.RepoConverter.ingest (   self)
inherited
Insert converted datasets into the Gen3 repository.

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

This method is guaranteed to be called after `expandDataIds`.

Definition at line 454 of file repoConverter.py.

◆ insertDimensionData()

def lsst.obs.base.gen2to3.repoConverter.RepoConverter.insertDimensionData (   self)
inherited
Insert any dimension records uniquely derived from this repository
into the registry.

Subclasses may override this method, but may not need to; the default
implementation does nothing.

SkyMap and SkyPix dimensions should instead be handled by calling
`ConvertRepoTask.useSkyMap` or `ConvertRepoTask.useSkyPix`, because
these dimensions are in general shared by multiple Gen2 repositories.

This method is guaranteed to be called between `prep` and
`expandDataIds`.

Definition at line 408 of file repoConverter.py.

◆ isDatasetTypeSpecial()

def lsst.obs.base.gen2to3.standardRepoConverter.StandardRepoConverter.isDatasetTypeSpecial (   self,
  datasetTypeName 
)

Definition at line 94 of file standardRepoConverter.py.

◆ iterDatasets()

def lsst.obs.base.gen2to3.standardRepoConverter.StandardRepoConverter.iterDatasets (   self,
  Iterator,
  FileDataset 
)

Definition at line 181 of file standardRepoConverter.py.

◆ iterMappings()

def lsst.obs.base.gen2to3.standardRepoConverter.StandardRepoConverter.iterMappings (   self,
  Iterator,
  Tuple,
  str,
  CameraMapperMapping 
)

Definition at line 123 of file standardRepoConverter.py.

◆ makeRepoWalkerTarget()

def lsst.obs.base.gen2to3.standardRepoConverter.StandardRepoConverter.makeRepoWalkerTarget (   self,
  datasetTypeName 
)

Definition at line 166 of file standardRepoConverter.py.

◆ prep()

def lsst.obs.base.gen2to3.standardRepoConverter.StandardRepoConverter.prep (   self)

Definition at line 98 of file standardRepoConverter.py.

Member Data Documentation

◆ butler2

lsst.obs.base.gen2to3.standardRepoConverter.StandardRepoConverter.butler2

Definition at line 90 of file standardRepoConverter.py.

◆ mapper

lsst.obs.base.gen2to3.standardRepoConverter.StandardRepoConverter.mapper

Definition at line 91 of file standardRepoConverter.py.

◆ root

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

Definition at line 206 of file repoConverter.py.

◆ subset

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

Definition at line 207 of file repoConverter.py.

◆ task

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

Definition at line 205 of file repoConverter.py.


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