lsst.pipe.base  19.0.0-18-gfb21c91+9
Public Member Functions | Public Attributes | List of all members
lsst.pipe.base.graphBuilder._DatasetScaffoldingDict Class Reference
Inheritance diagram for lsst.pipe.base.graphBuilder._DatasetScaffoldingDict:

Public Member Functions

def __init__ (self, *args, DimensionGraph universe)
 
_DatasetScaffoldingDict fromDatasetTypes (cls, Iterable[DatasetType] datasetTypes, *DimensionUniverse universe)
 
_DatasetScaffoldingDict fromSubset (cls, Iterable[DatasetType] datasetTypes, _DatasetScaffoldingDict first, *rest)
 
DimensionGraph dimensions (self)
 
NamedKeyDict unpackRefs (self)
 

Public Attributes

 universe
 

Detailed Description

Custom dictionary that maps `DatasetType` to `_DatasetScaffolding`.

See `_PipelineScaffolding` for a top-down description of the full
scaffolding data structure.

Parameters
----------
args
    Positional arguments are forwarded to the `dict` constructor.
universe : `DimensionUniverse`
    Universe of all possible dimensions.

Definition at line 122 of file graphBuilder.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.base.graphBuilder._DatasetScaffoldingDict.__init__ (   self,
args,
DimensionGraph  universe 
)

Definition at line 135 of file graphBuilder.py.

Member Function Documentation

◆ dimensions()

DimensionGraph lsst.pipe.base.graphBuilder._DatasetScaffoldingDict.dimensions (   self)
The union of all dimensions used by all dataset types in this
dictionary, including implied dependencies (`DimensionGraph`).

Definition at line 187 of file graphBuilder.py.

◆ fromDatasetTypes()

_DatasetScaffoldingDict lsst.pipe.base.graphBuilder._DatasetScaffoldingDict.fromDatasetTypes (   cls,
Iterable[DatasetType]  datasetTypes,
*DimensionUniverse  universe 
)
Construct a a dictionary from a flat iterable of `DatasetType` keys.

Parameters
----------
datasetTypes : `iterable` of `DatasetType`
    DatasetTypes to use as keys for the dict.  Values will be
    constructed from the dimensions of the keys.
universe : `DimensionUniverse`
    Universe of all possible dimensions.

Returns
-------
dictionary : `_DatasetScaffoldingDict`
    A new dictionary instance.

Definition at line 140 of file graphBuilder.py.

◆ fromSubset()

_DatasetScaffoldingDict lsst.pipe.base.graphBuilder._DatasetScaffoldingDict.fromSubset (   cls,
Iterable[DatasetType]  datasetTypes,
_DatasetScaffoldingDict  first,
rest 
)
Return a new dictionary by extracting items corresponding to the
given keys from one or more existing dictionaries.

Parameters
----------
datasetTypes : `iterable` of `DatasetType`
    DatasetTypes to use as keys for the dict.  Values will be obtained
    by lookups against ``first`` and ``rest``.
first : `_DatasetScaffoldingDict`
    Another dictionary from which to extract values.
rest
    Additional dictionaries from which to extract values.

Returns
-------
dictionary : `_DatasetScaffoldingDict`
    A new dictionary instance.

Definition at line 162 of file graphBuilder.py.

◆ unpackRefs()

NamedKeyDict lsst.pipe.base.graphBuilder._DatasetScaffoldingDict.unpackRefs (   self)
Unpack nested single-element `DatasetRef` lists into a new
dictionary.

This method assumes that each `_DatasetScaffolding.refs` list contains
exactly one `DatasetRef`, as is the case for all "init" datasets.

Returns
-------
dictionary : `NamedKeyDict`
    Dictionary mapping `DatasetType` to `DatasetRef`, with both
    `DatasetType` instances and string names usable as keys.

Definition at line 196 of file graphBuilder.py.

Member Data Documentation

◆ universe

lsst.pipe.base.graphBuilder._DatasetScaffoldingDict.universe

Definition at line 137 of file graphBuilder.py.


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