BaseConnection

class lsst.pipe.base.connectionTypes.BaseConnection(name: str, storageClass: str, doc: str = '', multiple: bool = False)

Bases: object

Base class used for declaring PipelineTask connections

Parameters:

namestr

The name used to identify the dataset type

storageClassstr

The storage class used when (un)/persisting the dataset type

multiplebool

Indicates if this connection should expect to contain multiple objects of the given dataset type. Tasks with more than one connection with multiple=True with the same dimensions may want to implement PipelineTaskConnections.adjustQuantum to ensure those datasets are consistent (i.e. zip-iterable) in PipelineTask.runQuantum and notify the execution system as early as possible of outputs that will not be produced because the corresponding input is missing.

Attributes Summary

doc
multiple

Methods Summary

makeDatasetType(universe[, parentStorageClass])

Construct a true DatasetType instance with normalized dimensions.

Attributes Documentation

doc: str = ''

multiple: bool = False

Methods Documentation

makeDatasetType(universe: DimensionUniverse, parentStorageClass: str | StorageClass | None = None) → DatasetType

Construct a true DatasetType instance with normalized dimensions.

Parameters:

universelsst.daf.butler.DimensionUniverse

Set of all known dimensions to be used to normalize the dimension names specified in config.

parentStorageClasslsst.daf.butler.StorageClass or str, optional

Parent storage class for component datasets; None otherwise.

Returns:

datasetTypeDatasetType

The DatasetType defined by this connection.