GraphBuilder

class lsst.pipe.base.GraphBuilder(registry, skipExisting=True, clobberExisting=False)

Bases: object

GraphBuilder class is responsible for building task execution graph from a Pipeline.

Parameters:
registry : Registry

Data butler instance.

skipExisting : bool, optional

If True (default), a Quantum is not created if all its outputs already exist.

clobberExisting : bool, optional

If True, overwrite any outputs that already exist. Cannot be True if skipExisting is.

Methods Summary

makeGraph(pipeline, inputCollections, …) Create execution graph for a pipeline.

Methods Documentation

makeGraph(pipeline, inputCollections, outputCollection, userQuery)

Create execution graph for a pipeline.

Parameters:
pipeline : Pipeline

Pipeline definition, task names/classes and their configs.

inputCollections : Mapping

Mapping from dataset type name to an ordered sequence of collections to search for that dataset. A defaultdict is recommended for the case where the same collections should be used for most datasets.

outputCollection : str

Collection for all output datasets.

userQuery : str

String which defunes user-defined selection for registry, should be empty or None if there is no restrictions on data selection.

Returns:
graph : QuantumGraph
Raises:
UserExpressionError

Raised when user expression cannot be parsed.

OutputExistsError

Raised when output datasets already exist.

Exception

Other exceptions types may be raised by underlying registry classes.