lsst.pipe.base  19.0.0-10-ged17d6e+1
Public Member Functions | List of all members
lsst.pipe.base.pipeline.Pipeline Class Reference

Public Member Functions

def __init__
 
def fromFile
 
def fromString
 
def fromIR
 
def fromPipeline
 
def __str__ (self)
 
def addInstrument
 
def addTask
 
def removeTask
 
def addConfigOverride
 
def addConfigFile
 
def addConfigPython
 
def toFile
 
def toExpandedPipeline (self)
 
def __len__ (self)
 
def __eq__
 

Detailed Description

A `Pipeline` is a representation of a series of tasks to run, and the
configuration for those tasks.

Parameters
----------
description : `str`
    A description of that this pipeline does.

Definition at line 108 of file pipeline.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.base.pipeline.Pipeline.__init__ (   self,
  description 
)

Definition at line 117 of file pipeline.py.

Member Function Documentation

◆ __eq__()

def lsst.pipe.base.pipeline.Pipeline.__eq__ (   self,
  other 
)

Definition at line 359 of file pipeline.py.

◆ __len__()

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

Definition at line 356 of file pipeline.py.

◆ __str__()

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

Definition at line 185 of file pipeline.py.

◆ addConfigFile()

def lsst.pipe.base.pipeline.Pipeline.addConfigFile (   self,
  label 
)

Definition at line 264 of file pipeline.py.

◆ addConfigOverride()

def lsst.pipe.base.pipeline.Pipeline.addConfigOverride (   self,
  label 
)

Definition at line 250 of file pipeline.py.

◆ addConfigPython()

def lsst.pipe.base.pipeline.Pipeline.addConfigPython (   self,
  label 
)

Definition at line 277 of file pipeline.py.

◆ addInstrument()

def lsst.pipe.base.pipeline.Pipeline.addInstrument (   self,
  instrument 
)

Definition at line 188 of file pipeline.py.

◆ addTask()

def lsst.pipe.base.pipeline.Pipeline.addTask (   self,
  task 
)

Definition at line 206 of file pipeline.py.

◆ fromFile()

def lsst.pipe.base.pipeline.Pipeline.fromFile (   cls,
  filename 
)

Definition at line 122 of file pipeline.py.

◆ fromIR()

def lsst.pipe.base.pipeline.Pipeline.fromIR (   cls,
  deserialized_pipeline 
)

Definition at line 154 of file pipeline.py.

◆ fromPipeline()

def lsst.pipe.base.pipeline.Pipeline.fromPipeline (   cls,
  pipeline 
)

Definition at line 171 of file pipeline.py.

◆ fromString()

def lsst.pipe.base.pipeline.Pipeline.fromString (   cls,
  pipeline_string 
)

Definition at line 138 of file pipeline.py.

◆ removeTask()

def lsst.pipe.base.pipeline.Pipeline.removeTask (   self,
  label 
)

Definition at line 234 of file pipeline.py.

◆ toExpandedPipeline()

def lsst.pipe.base.pipeline.Pipeline.toExpandedPipeline (   self,
  Generator,
  TaskDef 
)
Returns a generator of TaskDefs which can be used to create quantum
graphs.

Returns
-------
generator : generator of `TaskDef`
    The generator returned will be the sorted iterator of tasks which
    are to be used in constructing a quantum graph.

Raises
------
NotImplementedError
    If a dataId is supplied in a config block. This is in place for
    future use

Definition at line 299 of file pipeline.py.

◆ toFile()

def lsst.pipe.base.pipeline.Pipeline.toFile (   self,
  filename 
)

Definition at line 296 of file pipeline.py.


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