lsst.obs.base
tickets.DM-23835-g2f59a1585e
|
Public Member Functions | |
def | __init__ (self, config=None, *Butler3 butler3, **kwds) |
def | isDatasetTypeIncluded (self, str datasetTypeName) |
str | useSkyMap (self, BaseSkyMap skyMap) |
def | registerUsedSkyMaps (self, Optional[ConversionSubset] subset) |
def | useSkyPix (self, SkyPixDimension dimension) |
def | registerUsedSkyPix (self, Optional[ConversionSubset] subset) |
def | run (self, str root, List[str] collections, *Dict[str, List[str]] calibs=None, Dict[str, List[str]] reruns=None, Optional[Iterable[int]] visits=None) |
Public Attributes | |
butler3 | |
registry | |
universe | |
instrument | |
raws | |
Static Public Attributes | |
ConfigClass = ConvertRepoConfig | |
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` Gen3 Butler instance that represents the data repository datasets will be ingested into. The collection and/or run associated with this Butler will be ignored in favor of collections/runs passed via config or to `run`. kwds 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 216 of file convertRepo.py.
def lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.__init__ | ( | self, | |
config = None , |
|||
*Butler3 | butler3, | ||
** | kwds | ||
) |
Definition at line 247 of file convertRepo.py.
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 267 of file convertRepo.py.
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 316 of file convertRepo.py.
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 348 of file convertRepo.py.
def lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.run | ( | self, | |
str | root, | ||
List[str] | collections, | ||
*Dict[str, List[str]] | calibs = None , |
||
Dict[str, List[str]] | reruns = None , |
||
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. collections : `list` of `str` Gen3 collections that datasets from the root repository should be associated with. This should include any rerun collection that these datasets should also be considered to be part of; because of structural difference between Gen2 parent/child relationships and Gen3 collections, these cannot be reliably inferred. calibs : `dict` Dictionary mapping calibration repository path to the collections that the repository's datasets should be associated with. The path may be relative to ``root`` or absolute. Collections should include child repository collections as appropriate (see documentation for ``collections``). reruns : `dict` Dictionary mapping rerun repository path to the collections that the repository's datasets should be associated with. The path may be relative to ``root`` or absolute. Collections should include child repository collections as appropriate (see documentation for ``collections``). 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 365 of file convertRepo.py.
str lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.useSkyMap | ( | self, | |
BaseSkyMap | skyMap | ||
) |
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. Returns ------- name : `str` The name of the skymap in Gen3 data IDs.
Definition at line 291 of file convertRepo.py.
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 335 of file convertRepo.py.
lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.butler3 |
Definition at line 249 of file convertRepo.py.
|
static |
Definition at line 243 of file convertRepo.py.
lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.instrument |
Definition at line 254 of file convertRepo.py.
lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.raws |
Definition at line 256 of file convertRepo.py.
lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.registry |
Definition at line 250 of file convertRepo.py.
lsst.obs.base.gen2to3.convertRepo.ConvertRepoTask.universe |
Definition at line 251 of file convertRepo.py.