lsst.pipe.base  17.0.1-2-g3e5d191+28
Public Member Functions | Public Attributes | List of all members
lsst.pipe.base.graph.QuantumGraph Class Reference
Inheritance diagram for lsst.pipe.base.graph.QuantumGraph:

Public Member Functions

def __init__ (self, iterable=None)
 
def quanta (self)
 
def traverse (self)
 
def getDatasetTypes (self, initInputs=True, initOutputs=True, inputs=True, outputs=True)
 

Public Attributes

 initInputs
 
 initOutputs
 

Detailed Description

QuantumGraph is a sequence of `QuantumGraphTaskNodes` objects.

Typically the order of the tasks in the list will be the same as the
order of tasks in a pipeline (obviously depends on the code which
constructs graph).

Parameters
----------
iterable : iterable of `QuantumGraphTaskNodes`, optional
    Initial sequence of per-task nodes.

Definition at line 119 of file graph.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.base.graph.QuantumGraph.__init__ (   self,
  iterable = None 
)

Definition at line 131 of file graph.py.

Member Function Documentation

◆ getDatasetTypes()

def lsst.pipe.base.graph.QuantumGraph.getDatasetTypes (   self,
  initInputs = True,
  initOutputs = True,
  inputs = True,
  outputs = True 
)

Definition at line 218 of file graph.py.

◆ quanta()

def lsst.pipe.base.graph.QuantumGraph.quanta (   self)
Iterator over quanta in a graph.

Quanta are returned in unspecified order.

Yields
------
taskDef : `TaskDef`
    Task definition for a Quantum.
quantum : `~lsst.daf.butler.Quantum`
    Single quantum.

Definition at line 138 of file graph.py.

◆ traverse()

def lsst.pipe.base.graph.QuantumGraph.traverse (   self)
Return topologically ordered Quanta and their dependencies.

This method iterates over all Quanta in topological order, enumerating
them during iteration. Returned `QuantumIterData` object contains
Quantum instance, its ``quantumId`` and ``quantumId`` of all its
prerequsites (Quanta that produce inputs for this Quantum):
- the ``quantumId`` values are generated by an iteration of a
  QuantumGraph, and are not intrinsic to the QuantumGraph
- during iteration, each ID will appear in quantumId before it ever
  appears in dependencies.

Yields
------
quantumData : `QuantumIterData`

Definition at line 155 of file graph.py.

Member Data Documentation

◆ initInputs

lsst.pipe.base.graph.QuantumGraph.initInputs

Definition at line 133 of file graph.py.

◆ initOutputs

lsst.pipe.base.graph.QuantumGraph.initOutputs

Definition at line 134 of file graph.py.


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