lsst.pipe.base  17.0.1-5-g3877d06+6
Public Member Functions | List of all members
lsst.pipe.base.pipeline.Pipeline Class Reference
Inheritance diagram for lsst.pipe.base.pipeline.Pipeline:

Public Member Functions

def __init__ (self, iterable=None)
 
def labelIndex (self, label)
 
def __str__ (self)
 

Detailed Description

Pipeline is a sequence of `TaskDef` objects.

Pipeline is given as one of the inputs to a supervising framework
which builds execution graph out of it. Pipeline contains a sequence
of `TaskDef` instances.

Main purpose of this class is to provide a mechanism to pass pipeline
definition from users to supervising framework. That mechanism is
implemented using simple serialization and de-serialization via
`pickle`. Note that pipeline serialization is not guaranteed to be
compatible between different versions or releases.

In current implementation Pipeline is a list (it inherits from `list`)
and one can use all list methods on pipeline. Content of the pipeline
can be modified, it is up to the client to verify that modifications
leave pipeline in a consistent state. One could modify container
directly by adding or removing its elements.

Parameters
----------
pipeline : iterable of `TaskDef` instances, optional
    Initial sequence of tasks.

Definition at line 81 of file pipeline.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.base.pipeline.Pipeline.__init__ (   self,
  iterable = None 
)

Definition at line 105 of file pipeline.py.

Member Function Documentation

◆ __str__()

def lsst.pipe.base.pipeline.Pipeline.__str__ (   self)

Definition at line 126 of file pipeline.py.

◆ labelIndex()

def lsst.pipe.base.pipeline.Pipeline.labelIndex (   self,
  label 
)
Return task index given its label.

Parameters
----------
label : `str`
    Task label.

Returns
-------
index : `int`
    Task index, or -1 if label is not found.

Definition at line 108 of file pipeline.py.


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