lsst.obs.base  19.0.0-45-ge80c878+1
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask Class Reference
Inheritance diagram for lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask:

Public Member Functions

def __init__
 
def isDatasetTypeIncluded
 
def useSkyMap
 
def registerUsedSkyMaps
 
def useSkyPix
 
def registerUsedSkyPix
 
def run
 

Public Attributes

 butler3
 
 registry
 
 universe
 
 raws
 
 defineVisits
 
 instrument
 

Static Public Attributes

 ConfigClass = ConvertRepoConfig
 

Detailed Description

A task that converts one or more related Gen2 data repositories to a
single Gen3 data repository (with multiple collections).

Parameters
----------
config: `ConvertRepoConfig`
    Configuration for this task.
butler3: `lsst.daf.butler.Butler`
    A writeable Gen3 Butler instance that represents the data repository
    that datasets will be ingested into.  If the 'raw' dataset is
    configured to be included in the conversion, ``butler3.run`` should be
    set to the name of the collection raws should be ingested into, and
    ``butler3.collections`` should include a calibration collection from
    which the ``camera`` dataset can be loaded, unless a calibration repo
    is converted and ``doWriteCuratedCalibrations`` is `True`.
**kwargs
    Other keyword arguments are forwarded to the `Task` constructor.

Notes
-----
Most of the work of converting repositories is delegated to instances of
the `RepoConverter` hierarchy.  The `ConvertRepoTask` instance itself holds
only state that is relevant for all Gen2 repositories being ingested, while
each `RepoConverter` instance holds only state relevant for the conversion
of a single Gen2 repository.  Both the task and the `RepoConverter`
instances are single use; `ConvertRepoTask.run` and most `RepoConverter`
methods may only be called once on a particular instance.

Definition at line 287 of file convertRepo.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.__init__ (   self,
  config = None,
  butler3 
)

Definition at line 321 of file convertRepo.py.

Member Function Documentation

◆ isDatasetTypeIncluded()

def lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.isDatasetTypeIncluded (   self,
  datasetTypeName 
)

Definition at line 346 of file convertRepo.py.

◆ registerUsedSkyMaps()

def lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.registerUsedSkyMaps (   self,
  subset 
)

Definition at line 405 of file convertRepo.py.

◆ registerUsedSkyPix()

def lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.registerUsedSkyPix (   self,
  subset 
)

Definition at line 437 of file convertRepo.py.

◆ run()

def lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.run (   self,
  root 
)

Definition at line 454 of file convertRepo.py.

◆ useSkyMap()

def lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.useSkyMap (   self,
  skyMap 
)

Definition at line 370 of file convertRepo.py.

◆ useSkyPix()

def lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.useSkyPix (   self,
  dimension 
)

Definition at line 424 of file convertRepo.py.

Member Data Documentation

◆ butler3

lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.butler3

Definition at line 324 of file convertRepo.py.

◆ ConfigClass

lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.ConfigClass = ConvertRepoConfig
static

Definition at line 317 of file convertRepo.py.

◆ defineVisits

lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.defineVisits

Definition at line 332 of file convertRepo.py.

◆ instrument

lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.instrument

Definition at line 333 of file convertRepo.py.

◆ raws

lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.raws

Definition at line 331 of file convertRepo.py.

◆ registry

lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.registry

Definition at line 325 of file convertRepo.py.

◆ universe

lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.universe

Definition at line 326 of file convertRepo.py.


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