lsst.obs.base  20.0.0-45-g887e66a+a9aa579b69
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__ (self, config=None, *Butler3 butler3, Instrument instrument, **kwargs)
 
def isDatasetTypeIncluded (self, str datasetTypeName)
 
str useSkyMap (self, BaseSkyMap skyMap, str skyMapName)
 
def registerUsedSkyMaps (self, Optional[ConversionSubset] subset)
 
def useSkyPix (self, SkyPixDimension dimension)
 
def registerUsedSkyPix (self, Optional[ConversionSubset] subset)
 
def run (self, str root, *Dict[str, str] calibs=None, List[Rerun] reruns, Optional[Iterable[int]] visits=None)
 

Public Attributes

 butler3
 
 registry
 
 universe
 
 raws
 
 defineVisits
 
 instrument
 
 translatorFactory
 

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 269 of file convertRepo.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.__init__ (   self,
  config = None,
*Butler3  butler3,
Instrument  instrument,
**  kwargs 
)

Definition at line 303 of file convertRepo.py.

Member Function Documentation

◆ isDatasetTypeIncluded()

def lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.isDatasetTypeIncluded (   self,
str  datasetTypeName 
)
Return `True` if configuration indicates that the given dataset type
should be converted.

This method is intended to be called primarily by the
`RepoConverter` instances used interally by the task.

Parameters
----------
datasetTypeName: str
    Name of the dataset type.

Returns
-------
included : `bool`
    Whether the dataset should be included in the conversion.

Definition at line 330 of file convertRepo.py.

◆ registerUsedSkyMaps()

def lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.registerUsedSkyMaps (   self,
Optional[ConversionSubset subset 
)
Register all skymaps that have been marked as used.

This method is intended to be called primarily by the
`RepoConverter` instances used interally by the task.

Parameters
----------
subset : `ConversionSubset`, optional
    Object that will be used to filter converted datasets by data ID.
    If given, it will be updated with the tracts of this skymap that
    overlap the visits in the subset.

Definition at line 389 of file convertRepo.py.

◆ registerUsedSkyPix()

def lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.registerUsedSkyPix (   self,
Optional[ConversionSubset subset 
)
Register all skymaps that have been marked as used.

This method is intended to be called primarily by the
`RepoConverter` instances used interally by the task.

Parameters
----------
subset : `ConversionSubset`, optional
    Object that will be used to filter converted datasets by data ID.
    If given, it will be updated with the pixelization IDs that
    overlap the visits in the subset.

Definition at line 421 of file convertRepo.py.

◆ run()

def lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.run (   self,
str  root,
*Dict[str, str]   calibs = None,
List[Rerun reruns,
Optional[Iterable[int]]   visits = None 
)
Convert a group of related data repositories.

Parameters
----------
root : `str`
    Complete path to the root Gen2 data repository.  This should be
    a data repository that includes a Gen2 registry and any raw files
    and/or reference catalogs.
calibs : `dict`
    Dictionary mapping calibration repository path to the
    `~lsst.daf.butler.CollectionType.RUN` collection that converted
    datasets within it should be inserted into.
reruns : `list` of `Rerun`
    Specifications for rerun (processing output) collections to
    convert.
visits : iterable of `int`, optional
    The integer IDs of visits to convert.  If not provided, all visits
    in the Gen2 root repository will be converted.

Definition at line 438 of file convertRepo.py.

◆ useSkyMap()

str lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.useSkyMap (   self,
BaseSkyMap  skyMap,
str  skyMapName 
)
Indicate that a repository uses the given SkyMap.

This method is intended to be called primarily by the
`RepoConverter` instances used interally by the task.

Parameters
----------
skyMap : `lsst.skymap.BaseSkyMap`
    SkyMap instance being used, typically retrieved from a Gen2
    data repository.
skyMapName : `str`
    The name of the gen2 skymap, for error reporting.

Returns
-------
name : `str`
    The name of the skymap in Gen3 data IDs.

Raises
------
    LookupError
Raised if the specified skymap cannot be found.

Definition at line 354 of file convertRepo.py.

◆ useSkyPix()

def lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.useSkyPix (   self,
SkyPixDimension  dimension 
)
Indicate that a repository uses the given SkyPix dimension.

This method is intended to be called primarily by the
`RepoConverter` instances used interally by the task.

Parameters
----------
dimension : `lsst.daf.butler.SkyPixDimension`
    Dimension represening a pixelization of the sky.

Definition at line 408 of file convertRepo.py.

Member Data Documentation

◆ butler3

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

Definition at line 306 of file convertRepo.py.

◆ ConfigClass

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

Definition at line 299 of file convertRepo.py.

◆ defineVisits

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

Definition at line 314 of file convertRepo.py.

◆ instrument

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

Definition at line 315 of file convertRepo.py.

◆ raws

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

Definition at line 313 of file convertRepo.py.

◆ registry

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

Definition at line 307 of file convertRepo.py.

◆ translatorFactory

lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.translatorFactory

Definition at line 322 of file convertRepo.py.

◆ universe

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

Definition at line 308 of file convertRepo.py.


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