Public Member Functions
def	__init__ (self, _TaskScaffolding task, DataCoordinate dataId)

def	__repr__ (self)

Quantum	makeQuantum (self)

Public Attributes
	task

	dataId

	inputs

	outputs

	prerequisites

Detailed Description

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

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

Parameters
----------
task : _TaskScaffolding
    Back-reference to the helper object for the `PipelineTask` this quantum
    represents an execution of.
dataId : `DataCoordinate`
    Data ID for this quantum.

Definition at line 185 of file graphBuilder.py.

Constructor & Destructor Documentation

◆ init()

def lsst.pipe.base.graphBuilder._QuantumScaffolding.__init__	(		self,
		_TaskScaffolding	task,
		DataCoordinate	dataId
	)

Definition at line 200 of file graphBuilder.py.

     def __init__(self, task: _TaskScaffolding, dataId: DataCoordinate):
         self.task = task
         self.dataId = dataId
         self.inputs = _DatasetDict.fromDatasetTypes(task.inputs.keys(), universe=dataId.universe)
         self.outputs = _DatasetDict.fromDatasetTypes(task.outputs.keys(), universe=dataId.universe)
         self.prerequisites = _DatasetDict.fromDatasetTypes(task.prerequisites.keys(),
                                                            universe=dataId.universe)
  

Member Function Documentation

◆ repr()

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

Definition at line 210 of file graphBuilder.py.

     def __repr__(self):
         return f"_QuantumScaffolding(taskDef={self.task.taskDef}, dataId={self.dataId}, ...)"
  

◆ makeQuantum()

Quantum lsst.pipe.base.graphBuilder._QuantumScaffolding.makeQuantum ( self )

Transform the scaffolding object into a true `Quantum` instance.

Returns
-------
quantum : `Quantum`
    An actual `Quantum` instance.

Definition at line 240 of file graphBuilder.py.

     def makeQuantum(self) -> Quantum:
         """Transform the scaffolding object into a true `Quantum` instance.
  
         Returns
         -------
         quantum : `Quantum`
             An actual `Quantum` instance.
         """
         allInputs = self.inputs.unpackMultiRefs()
         allInputs.update(self.prerequisites.unpackMultiRefs())
         # Give the task's Connections class an opportunity to remove some
         # inputs, or complain if they are unacceptable.
         # This will raise if one of the check conditions is not met, which is
         # the intended behavior
         allInputs = self.task.taskDef.connections.adjustQuantum(allInputs)
         return Quantum(
             taskName=self.task.taskDef.taskName,
             taskClass=self.task.taskDef.taskClass,
             dataId=self.dataId,
             initInputs=self.task.initInputs.unpackSingleRefs(),
             inputs=allInputs,
             outputs=self.outputs.unpackMultiRefs(),
         )
  
  
 @dataclass

Member Data Documentation

◆ dataId

lsst.pipe.base.graphBuilder._QuantumScaffolding.dataId

Definition at line 202 of file graphBuilder.py.

◆ inputs

lsst.pipe.base.graphBuilder._QuantumScaffolding.inputs

Definition at line 203 of file graphBuilder.py.

◆ outputs

lsst.pipe.base.graphBuilder._QuantumScaffolding.outputs

Definition at line 204 of file graphBuilder.py.

◆ prerequisites

lsst.pipe.base.graphBuilder._QuantumScaffolding.prerequisites

Definition at line 205 of file graphBuilder.py.

◆ task

lsst.pipe.base.graphBuilder._QuantumScaffolding.task

Definition at line 201 of file graphBuilder.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.4.3/Linux64/pipe_base/22.0.1+94e66cc9ed/python/lsst/pipe/base/graphBuilder.py

Public Member Functions

Public Attributes