lsst.pipe.base  20.0.0-21-gb65c2a3+a8acb598c9
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.base.connectionTypes.PrerequisiteInput Class Reference
Inheritance diagram for lsst.pipe.base.connectionTypes.PrerequisiteInput:
lsst.pipe.base.connectionTypes.BaseInput lsst.pipe.base.connectionTypes.DimensionedConnection lsst.pipe.base.connectionTypes.BaseConnection

Public Member Functions

def __post_init__ (self)
 
def makeDatasetType (self, DimensionUniverse universe, Optional[StorageClass] parentStorageClass=None)
 
def __get__ (self, inst, klass)
 

Static Public Attributes

 frozen
 
 bool
 
 str
 

Detailed Description

Class used for declaring PipelineTask prerequisite connections

Parameters
----------
name : `str`
    The default name used to identify the dataset type
storageClass : `str`
    The storage class used when (un)/persisting the dataset type
multiple : `bool`
    Indicates if this connection should expect to contain multiple objects
    of the given dataset type
dimensions : iterable of `str`
    The `lsst.daf.butler.Butler` `lsst.daf.butler.Registry` dimensions used
    to identify the dataset type identified by the specified name
deferLoad : `bool`
    Indicates that this dataset type will be loaded as a
    `lsst.daf.butler.DeferredDatasetHandle`. PipelineTasks can use this
    object to load the object at a later time.
lookupFunction: `typing.Callable`, optional
    An optional callable function that will look up PrerequisiteInputs
    using the DatasetType, registry, quantum dataId, and input collections
    passed to it. If no function is specified, the default temporal spatial
    lookup will be used.

Definition at line 202 of file connectionTypes.py.

Member Function Documentation

◆ __get__()

def lsst.pipe.base.connectionTypes.BaseConnection.__get__ (   self,
  inst,
  klass 
)
inherited
Descriptor method

This is a method used to turn a connection into a descriptor.
When a connection is added to a connection class, it is a class level
variable. This method makes accessing this connection, on the
instance of the connection class owning this connection, return a
result specialized for that instance. In the case of connections
this specifically means names specified in a config instance will
be visible instead of the default names for the connection.

Definition at line 63 of file connectionTypes.py.

◆ __post_init__()

def lsst.pipe.base.connectionTypes.DimensionedConnection.__post_init__ (   self)
inherited

Definition at line 143 of file connectionTypes.py.

◆ makeDatasetType()

def lsst.pipe.base.connectionTypes.DimensionedConnection.makeDatasetType (   self,
DimensionUniverse  universe,
Optional[StorageClass]   parentStorageClass = None 
)
inherited
Construct a true `DatasetType` instance with normalized dimensions.
Parameters
----------
universe : `lsst.daf.butler.DimensionUniverse`
    Set of all known dimensions to be used to normalize the dimension
    names specified in config.
parentStorageClass : `lsst.daf.butler.StorageClass`, optional
    Parent storage class for component datasets; `None` otherwise.

Returns
-------
datasetType : `DatasetType`
    The `DatasetType` defined by this connection.

Reimplemented from lsst.pipe.base.connectionTypes.BaseConnection.

Definition at line 150 of file connectionTypes.py.

Member Data Documentation

◆ bool

lsst.pipe.base.connectionTypes.BaseInput.bool
staticinherited

Definition at line 193 of file connectionTypes.py.

◆ frozen

lsst.pipe.base.connectionTypes.PrerequisiteInput.frozen
static

Definition at line 231 of file connectionTypes.py.

◆ str

lsst.pipe.base.connectionTypes.BaseConnection.str
staticinherited

Definition at line 60 of file connectionTypes.py.


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