lsst.pipe.base  18.1.0-6-g48bdcd3
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.base.connectionTypes.BaseInput Class Reference
Inheritance diagram for lsst.pipe.base.connectionTypes.BaseInput:
lsst.pipe.base.connectionTypes.DimensionedConnection lsst.pipe.base.connectionTypes.BaseConnection lsst.pipe.base.connectionTypes.Input lsst.pipe.base.connectionTypes.PrerequisiteInput

Public Member Functions

def makeDatasetType
 
def __get__ (self, inst, klass)
 

Static Public Attributes

 bool
 
 frozen
 
 str
 

Detailed Description

Class used for declaring PipelineTask input connections

Parameters
----------
name : `str`
    The 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.

Definition at line 126 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 54 of file connectionTypes.py.

◆ makeDatasetType()

def lsst.pipe.base.connectionTypes.DimensionedConnection.makeDatasetType (   self,
  universe 
)
inherited

Definition at line 108 of file connectionTypes.py.

Member Data Documentation

◆ bool

lsst.pipe.base.connectionTypes.BaseInput.bool
static

Definition at line 146 of file connectionTypes.py.

◆ frozen

lsst.pipe.base.connectionTypes.BaseInput.frozen
static

Definition at line 149 of file connectionTypes.py.

◆ str

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

Definition at line 51 of file connectionTypes.py.


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