GraphBuilder

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

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.

Methods Summary

makeGraph(pipeline, collections, run, userQuery) Create execution graph for a pipeline.

Methods Documentation

makeGraph(pipeline, collections, run, userQuery)

Create execution graph for a pipeline.

Parameters:
pipeline : Pipeline

Pipeline definition, task names/classes and their configs.

collections

Expressions representing the collections to search for input datasets. May be any of the types accepted by lsst.daf.butler.CollectionSearch.fromExpression.

run : str, optional

Name of the RUN collection for output datasets, if it already exists.

userQuery : str

String which defines 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.