lsst.obs.base
20.0.0-20-g8c202bc
|
Public Member Functions | |
def | __init__ (self, **kwds) |
bool | isDatasetTypeSpecial (self, str datasetTypeName) |
def | prep (self) |
Iterator[Tuple[str, CameraMapperMapping]] | iterMappings (self) |
Tuple[Optional[BaseSkyMap], Optional[str]] | findMatchingSkyMap (self, str datasetTypeName) |
RepoWalker.Target | makeRepoWalkerTarget (self, str datasetTypeName, str template, Dict[str, type] keys, StorageClass storageClass, FormatterParameter formatter=None, Optional[PathElementHandler] targetHandler=None) |
Iterator[FileDataset] | iterDatasets (self) |
List[str] | getSpecialDirectories (self) |
def | findDatasets (self) |
def | insertDimensionData (self) |
def | expandDataIds (self) |
def | ingest (self) |
str | getRun (self, str datasetTypeName) |
Public Attributes | |
butler2 | |
mapper | |
task | |
root | |
subset | |
A specialization of `RepoConverter` for non-calibration repositories. Parameters ---------- kwds Keyword arguments are forwarded to (and required by) `RepoConverter`.
Definition at line 77 of file standardRepoConverter.py.
def lsst.obs.base.gen2to3.standardRepoConverter.StandardRepoConverter.__init__ | ( | self, | |
** | kwds | ||
) |
Reimplemented in lsst.obs.base.gen2to3.rootRepoConverter.RootRepoConverter.
Definition at line 86 of file standardRepoConverter.py.
|
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 449 of file repoConverter.py.
|
inherited |
Definition at line 419 of file repoConverter.py.
Tuple[Optional[BaseSkyMap], Optional[str]] lsst.obs.base.gen2to3.standardRepoConverter.StandardRepoConverter.findMatchingSkyMap | ( | self, | |
str | datasetTypeName | ||
) |
Return the appropriate SkyMap for the given dataset type. Parameters ---------- datasetTypeName : `str` Name of the dataset type for which a skymap is sought. Returns ------- skyMap : `BaseSkyMap` or `None` The `BaseSkyMap` instance, or `None` if there was no match. skyMapName : `str` or `None` The Gen3 name for the SkyMap, or `None` if there was no match.
Reimplemented in lsst.obs.base.gen2to3.rootRepoConverter.RootRepoConverter.
Definition at line 130 of file standardRepoConverter.py.
|
inherited |
Return the name of the run to insert instances of the given dataset type into in this collection. Parameters ---------- datasetTypeName : `str` Name of the dataset type. Returns ------- run : `str` Name of the `~lsst.daf.butler.CollectionType.RUN` collection.
Reimplemented in lsst.obs.base.gen2to3.rootRepoConverter.RootRepoConverter.
Definition at line 501 of file repoConverter.py.
|
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.
Reimplemented in lsst.obs.base.gen2to3.rootRepoConverter.RootRepoConverter.
Definition at line 288 of file repoConverter.py.
|
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 478 of file repoConverter.py.
|
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`.
Reimplemented in lsst.obs.base.gen2to3.calibRepoConverter.CalibRepoConverter.
Definition at line 433 of file repoConverter.py.
bool lsst.obs.base.gen2to3.standardRepoConverter.StandardRepoConverter.isDatasetTypeSpecial | ( | self, | |
str | datasetTypeName | ||
) |
Test whether the given dataset is handled specially by this converter and hence should be ignored by generic base-class logic that searches for dataset types to convert. Parameters ---------- datasetTypeName : `str` Name of the dataset type to test. Returns ------- special : `bool` `True` if the dataset type is special.
Reimplemented from lsst.obs.base.gen2to3.repoConverter.RepoConverter.
Reimplemented in lsst.obs.base.gen2to3.rootRepoConverter.RootRepoConverter.
Definition at line 95 of file standardRepoConverter.py.
Iterator[FileDataset] lsst.obs.base.gen2to3.standardRepoConverter.StandardRepoConverter.iterDatasets | ( | self | ) |
Iterate over datasets in the repository that should be ingested into the Gen3 repository. The base class implementation yields nothing; the datasets handled by the `RepoConverter` base class itself are read directly in `findDatasets`. Subclasses should override this method if they support additional datasets that are handled some other way. Yields ------ dataset : `FileDataset` Structures representing datasets to be ingested. Paths should be absolute.
Reimplemented from lsst.obs.base.gen2to3.repoConverter.RepoConverter.
Reimplemented in lsst.obs.base.gen2to3.rootRepoConverter.RootRepoConverter.
Definition at line 188 of file standardRepoConverter.py.
Iterator[Tuple[str, CameraMapperMapping]] lsst.obs.base.gen2to3.standardRepoConverter.StandardRepoConverter.iterMappings | ( | self | ) |
Iterate over all `CameraMapper` `Mapping` objects that should be considered for conversion by this repository. This this should include any datasets that may appear in the repository, including those that are special (see `isDatasetTypeSpecial`) and those that are being ignored (see `ConvertRepoTask.isDatasetTypeIncluded`); this allows the converter to identify and hence skip these datasets quietly instead of warning about them as unrecognized. Yields ------ datasetTypeName: `str` Name of the dataset type. mapping : `lsst.obs.base.mapping.Mapping` Mapping object used by the Gen2 `CameraMapper` to describe the dataset type.
Reimplemented from lsst.obs.base.gen2to3.repoConverter.RepoConverter.
Definition at line 124 of file standardRepoConverter.py.
RepoWalker.Target lsst.obs.base.gen2to3.standardRepoConverter.StandardRepoConverter.makeRepoWalkerTarget | ( | self, | |
str | datasetTypeName, | ||
str | template, | ||
Dict[str, type] | keys, | ||
StorageClass | storageClass, | ||
FormatterParameter | formatter = None , |
||
Optional[PathElementHandler] | targetHandler = None |
||
) |
Make a struct that identifies a dataset type to be extracted by walking the repo directory structure. Parameters ---------- datasetTypeName : `str` Name of the dataset type (the same in both Gen2 and Gen3). template : `str` The full Gen2 filename template. keys : `dict` [`str`, `type`] A dictionary mapping Gen2 data ID key to the type of its value. storageClass : `lsst.daf.butler.StorageClass` Gen3 storage class for this dataset type. formatter : `lsst.daf.butler.Formatter` or `str`, optional A Gen 3 formatter class or fully-qualified name. targetHandler : `PathElementHandler`, optional Specialist target handler to use for this dataset type. Returns ------- target : `RepoWalker.Target` A struct containing information about the target dataset (much of it simplify forwarded from the arguments).
Reimplemented from lsst.obs.base.gen2to3.repoConverter.RepoConverter.
Definition at line 167 of file standardRepoConverter.py.
def lsst.obs.base.gen2to3.standardRepoConverter.StandardRepoConverter.prep | ( | self | ) |
Perform preparatory work associated with the dataset types to be converted from this repository (but not the datasets themselves). Notes ----- This should be a relatively fast operation that should not depend on the size of the repository. Subclasses may override this method, but must delegate to the base class implementation at some point in their own logic. More often, subclasses will specialize the behavior of `prep` by overriding other methods to which the base class implementation delegates. These include: - `iterMappings` - `isDatasetTypeSpecial` - `getSpecialDirectories` - `makeRepoWalkerTarget` This should not perform any write operations to the Gen3 repository. It is guaranteed to be called before `insertDimensionData`.
Reimplemented from lsst.obs.base.gen2to3.repoConverter.RepoConverter.
Reimplemented in lsst.obs.base.gen2to3.rootRepoConverter.RootRepoConverter.
Definition at line 99 of file standardRepoConverter.py.
lsst.obs.base.gen2to3.standardRepoConverter.StandardRepoConverter.butler2 |
Definition at line 91 of file standardRepoConverter.py.
lsst.obs.base.gen2to3.standardRepoConverter.StandardRepoConverter.mapper |
Definition at line 92 of file standardRepoConverter.py.
|
inherited |
Definition at line 209 of file repoConverter.py.
|
inherited |
Definition at line 210 of file repoConverter.py.
|
inherited |
Definition at line 208 of file repoConverter.py.