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

Public Member Functions

def __init__ (self, kwds)
 
def isDatasetTypeSpecial
 
def getSpecialDirectories (self)
 
def findMatchingSkyMap
 
def runRawIngest (self)
 
def runDefineVisits (self)
 
def prep (self)
 
def iterDatasets (self)
 
def getRun
 
def getCollectionChain (self)
 
def iterMappings (self)
 
def makeRepoWalkerTarget
 
def findDatasets (self)
 
def insertDimensionData (self)
 
def expandDataIds (self)
 
def ingest (self)
 

Public Attributes

 butler2
 
 mapper
 
 task
 
 root
 
 subset
 

Detailed Description

A specialization of `RepoConverter` for root data repositories.

`RootRepoConverter` adds support for raw images (mostly delegated to the
parent task's `RawIngestTask` subtask) and reference catalogs.

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

Definition at line 63 of file rootRepoConverter.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.obs.base.gen2to3.rootRepoConverter.RootRepoConverter.__init__ (   self,
  kwds 
)

Definition at line 75 of file rootRepoConverter.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.

◆ findMatchingSkyMap()

def lsst.obs.base.gen2to3.rootRepoConverter.RootRepoConverter.findMatchingSkyMap (   self,
  datasetTypeName 
)

Definition at line 98 of file rootRepoConverter.py.

◆ getCollectionChain()

def lsst.obs.base.gen2to3.rootRepoConverter.RootRepoConverter.getCollectionChain (   self,
  List,
  Tuple,
  str,
  Set,
  str 
)
Return tuples of run name and associated dataset type names that
can be used to construct a chained collection that refers to the
converted root repository (`list` [ `tuple` ]).

Definition at line 193 of file rootRepoConverter.py.

◆ getRun()

def lsst.obs.base.gen2to3.rootRepoConverter.RootRepoConverter.getRun (   self,
  datasetTypeName 
)

Definition at line 187 of file rootRepoConverter.py.

◆ getSpecialDirectories()

def lsst.obs.base.gen2to3.rootRepoConverter.RootRepoConverter.getSpecialDirectories (   self,
  List,
  str 
)

Definition at line 94 of file rootRepoConverter.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 475 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 430 of file repoConverter.py.

◆ isDatasetTypeSpecial()

def lsst.obs.base.gen2to3.rootRepoConverter.RootRepoConverter.isDatasetTypeSpecial (   self,
  datasetTypeName 
)

Definition at line 85 of file rootRepoConverter.py.

◆ iterDatasets()

def lsst.obs.base.gen2to3.rootRepoConverter.RootRepoConverter.iterDatasets (   self,
  Iterator,
  FileDataset 
)

Definition at line 164 of file rootRepoConverter.py.

◆ iterMappings()

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

Definition at line 124 of file standardRepoConverter.py.

◆ makeRepoWalkerTarget()

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

Definition at line 167 of file standardRepoConverter.py.

◆ prep()

def lsst.obs.base.gen2to3.rootRepoConverter.RootRepoConverter.prep (   self)

Definition at line 134 of file rootRepoConverter.py.

◆ runDefineVisits()

def lsst.obs.base.gen2to3.rootRepoConverter.RootRepoConverter.runDefineVisits (   self)

Definition at line 126 of file rootRepoConverter.py.

◆ runRawIngest()

def lsst.obs.base.gen2to3.rootRepoConverter.RootRepoConverter.runRawIngest (   self)

Definition at line 110 of file rootRepoConverter.py.

Member Data Documentation

◆ butler2

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

Definition at line 91 of file standardRepoConverter.py.

◆ mapper

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

Definition at line 92 of file standardRepoConverter.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: