QuantaCluster

class lsst.ctrl.bps.QuantaCluster(name, label, tags=None)

Bases: object

Information about the cluster and Quanta belonging to it.

Parameters:

name: `str`

Lookup key (logical file name) of file/directory. Must be unique within ClusteredQuantumGraph.

label: `str`

Value used to group clusters.

tags : dict [str, Any], optional

Arbitrary key/value pairs for the cluster.

Raises:

ValueError

Raised if invalid name (e.g., name contains /)

Attributes Summary

qgraph_node_ids	QuantumGraph NodeIds corresponding to this cluster.
quanta_counts	Counts of Quanta per taskDef.label in this cluster.

Methods Summary

add_quantum(node_id, task_label)	Add a quantumNode to this cluster.
add_quantum_node(quantum_node)	Add a quantumNode to this cluster.
from_quantum_node(quantum_node, template)	Create single quantum cluster from given quantum node.

Attributes Documentation

qgraph_node_ids

QuantumGraph NodeIds corresponding to this cluster.

quanta_counts

Counts of Quanta per taskDef.label in this cluster.

Methods Documentation

add_quantum(node_id, task_label)

Add a quantumNode to this cluster.

Parameters:

node_id : lsst.pipe.base.NodeId

ID for quantumNode to be added to cluster.

task_label : str

Task label for quantumNode to be added to cluster.

add_quantum_node(quantum_node)

Add a quantumNode to this cluster.

Parameters:

quantum_node : lsst.pipe.base.QuantumNode

classmethod from_quantum_node(quantum_node, template)

Create single quantum cluster from given quantum node.

Parameters:

quantum_node : lsst.pipe.base.QuantumNode

QuantumNode for which to make into a single quantum cluster.

template : str

Template for creating cluster name.

Returns:

cluster : QuantaCluster

Newly created cluster containing the given quantum.