|
def | handle (self, str path, nextDataId2, Mapping[DatasetType, List[FileDataset]] datasets, *Log log, Callable[[DataCoordinate], bool] predicate) |
|
Optional[DataCoordinate] | translate (self, dict dataId2, *bool partial=False, Log log) |
|
def | __str__ (self) |
|
bool | isForFiles (self) |
|
def | handle (self, str path, dict nextDataId2, Mapping[DatasetType, List[FileDataset]] datasets, *Log log, Callable[[DataCoordinate], bool] predicate) |
|
bool | __call__ (self, str path, str name, Mapping[DatasetType, List[FileDataset]] datasets, *Log log, Callable[[DataCoordinate], bool] predicate) |
|
int | rank (self) |
|
def | __lt__ (self, PathElementHandler other) |
|
Handler for FITS files that store image and metadata in multiple HDUs
per file, for example DECam raw and Community Pipeline calibrations.
Notes
-----
For now, this is only used by DECam, and may need to be made more generic
(e.g. making ``metadata['CCDNUM']`` use a configurable field) to be used
with other obs packages.
Definition at line 309 of file handlers.py.
bool lsst.obs.base.gen2to3.repoWalker.handlers.ParsedPathElementHandler.__call__ |
( |
|
self, |
|
|
str |
path, |
|
|
str |
name, |
|
|
Mapping[DatasetType, List[FileDataset]] |
datasets, |
|
|
*Log |
log, |
|
|
Callable[[DataCoordinate], bool] |
predicate |
|
) |
| |
|
inherited |
Apply the handler to a file path.
Parameters
----------
path : `str`
Full path of the file or directory.
name : `str`
Local name of the file or directory within its parent directory.
datasets : `dict` [`DatasetType`, `list` [`FileDataset`] ]
Dictionary that found datasets should be added to.
log : `Log`, optional
Log to use to report warnings and debug information.
predicate : `~collections.abc.Callable`
A callable taking a single `DataCoordinate` argument and returning
`bool`, indicating whether that (Gen3) data ID represents one
that should be included in the scan.'
Returns
-------
matched : `bool`
`True` if this handler was a match for the given path and no other
handlers need to be tried on it, `False` otherwise.
Reimplemented from lsst.obs.base.gen2to3.repoWalker.scanner.PathElementHandler.
Definition at line 119 of file handlers.py.
def lsst.obs.base.gen2to3.repoWalker.handlers.ParsedPathElementHandler.handle |
( |
|
self, |
|
|
str |
path, |
|
|
dict |
nextDataId2, |
|
|
Mapping[DatasetType, List[FileDataset]] |
datasets, |
|
|
*Log |
log, |
|
|
Callable[[DataCoordinate], bool] |
predicate |
|
) |
| |
|
inherited |
Customization hook for ``__call__``.
Subclasses must override this method, while external callers (i.e.
`DirectoryScanner` should instead invoke `__call__`.
Parameters
----------
path : `str`
Full path of the file or directory.
nextDataId2 : `dict`
Gen2 data ID (usually partial) extracted from the path so far.
datasets : `dict` [`DatasetType`, `list` [`FileDataset`] ]
Dictionary that found datasets should be added to.
log : `Log`, optional
Log to use to report warnings and debug information.
predicate : `~collections.abc.Callable`
A callable taking a single `DataCoordinate` argument and returning
`bool`, indicating whether that (Gen3) data ID represents one
that should be included in the scan.
formatterMap : `dict`, optional
Map dataset type to specialist formatter.
Reimplemented in lsst.obs.base.gen2to3.repoWalker.handlers.SkipHandler.
Definition at line 134 of file handlers.py.
Optional[DataCoordinate] lsst.obs.base.gen2to3.repoWalker.handlers.MultiExtensionFileHandler.translate |
( |
|
self, |
|
|
dict |
dataId2, |
|
|
*bool |
partial = False , |
|
|
Log |
log |
|
) |
| |
Translate the given data ID from Gen2 to Gen3.
The default implementation returns `None`. Subclasses that are able
to translate data IDs should override this method.
Parameters
----------
dataId2 : `dict`
Gen2 data ID.
partial : `bool`, optional
If `True` (`False` is default) this is a partial data ID for some
dataset, and missing keys are expected.
log : log : `Log`, optional
Log to use to report warnings and debug information.
Returns
-------
dataId3 : `lsst.daf.butler.DataCoordinate` or `None`
A Gen3 data ID, or `None` if this handler cannot translate data
IDs.
Reimplemented from lsst.obs.base.gen2to3.repoWalker.handlers.TargetFileHandler.
Definition at line 347 of file handlers.py.