lsst.pipe.base  19.0.0-18-gfb21c91+5
Public Member Functions | Public Attributes | List of all members
lsst.pipe.base.graphBuilder._TaskScaffolding Class Reference

Public Member Functions

def __init__ (self, TaskDef taskDef, _PipelineScaffolding parent, TaskDatasetTypes datasetTypes)
 
def __repr__ (self)
 
def addQuantum (self, Quantum quantum)
 
QuantumGraphTaskNodes makeQuantumGraphTaskNodes (self)
 

Public Attributes

 taskDef
 
 dimensions
 
 initInputs
 
 initOutputs
 
 inputs
 
 outputs
 
 prerequisites
 
 dataIds
 
 quanta
 

Detailed Description

Helper class aggregating information about a `PipelineTask`, used when
constructing a `QuantumGraph`.

See `_PipelineScaffolding` for a top-down description of the full
scaffolding data structure.

Parameters
----------
taskDef : `TaskDef`
    Data structure that identifies the task class and its config.
parent : `_PipelineScaffolding`
    The parent data structure that will hold the instance being
    constructed.
datasetTypes : `TaskDatasetTypes`
    Data structure that categorizes the dataset types used by this task.

Raises
------
GraphBuilderError
    Raised if the task's dimensions are not a subset of the union of the
    pipeline's dataset dimensions.

Definition at line 213 of file graphBuilder.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.base.graphBuilder._TaskScaffolding.__init__ (   self,
TaskDef  taskDef,
_PipelineScaffolding  parent,
TaskDatasetTypes  datasetTypes 
)

Definition at line 236 of file graphBuilder.py.

Member Function Documentation

◆ __repr__()

def lsst.pipe.base.graphBuilder._TaskScaffolding.__repr__ (   self)

Definition at line 268 of file graphBuilder.py.

◆ addQuantum()

def lsst.pipe.base.graphBuilder._TaskScaffolding.addQuantum (   self,
Quantum  quantum 
)

Definition at line 321 of file graphBuilder.py.

◆ makeQuantumGraphTaskNodes()

QuantumGraphTaskNodes lsst.pipe.base.graphBuilder._TaskScaffolding.makeQuantumGraphTaskNodes (   self)
Create a `QuantumGraphTaskNodes` instance from the information in
``self``.

Returns
-------
nodes : `QuantumGraphTaskNodes`
    The `QuantumGraph` elements corresponding to this task.

Definition at line 333 of file graphBuilder.py.

Member Data Documentation

◆ dataIds

lsst.pipe.base.graphBuilder._TaskScaffolding.dataIds

Definition at line 265 of file graphBuilder.py.

◆ dimensions

lsst.pipe.base.graphBuilder._TaskScaffolding.dimensions

Definition at line 239 of file graphBuilder.py.

◆ initInputs

lsst.pipe.base.graphBuilder._TaskScaffolding.initInputs

Definition at line 247 of file graphBuilder.py.

◆ initOutputs

lsst.pipe.base.graphBuilder._TaskScaffolding.initOutputs

Definition at line 249 of file graphBuilder.py.

◆ inputs

lsst.pipe.base.graphBuilder._TaskScaffolding.inputs

Definition at line 251 of file graphBuilder.py.

◆ outputs

lsst.pipe.base.graphBuilder._TaskScaffolding.outputs

Definition at line 253 of file graphBuilder.py.

◆ prerequisites

lsst.pipe.base.graphBuilder._TaskScaffolding.prerequisites

Definition at line 255 of file graphBuilder.py.

◆ quanta

lsst.pipe.base.graphBuilder._TaskScaffolding.quanta

Definition at line 266 of file graphBuilder.py.

◆ taskDef

lsst.pipe.base.graphBuilder._TaskScaffolding.taskDef

Definition at line 238 of file graphBuilder.py.


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