Inheritance diagram for lsst.pipe.base.graphBuilder.GraphBuilder:

Public Member Functions
def	__init__ (self, registry, skipExisting=True, clobberExisting=False)

def	makeGraph (self, pipeline, inputCollections, outputCollection, userQuery)

Public Attributes
	registry

	dimensions

	skipExisting

	clobberExisting

Detailed Description

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

Parameters
----------
registry : `~lsst.daf.butler.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.

Definition at line 717 of file graphBuilder.py.

Constructor & Destructor Documentation

◆ init()

def lsst.pipe.base.graphBuilder.GraphBuilder.__init__	(	self,
		registry,
		skipExisting = `True`,
		clobberExisting = `False`
	)

Definition at line 733 of file graphBuilder.py.

Member Function Documentation

◆ makeGraph()

def lsst.pipe.base.graphBuilder.GraphBuilder.makeGraph	(	self,
		pipeline,
		inputCollections,
		outputCollection,
		userQuery
	)

Create execution graph for a pipeline.

Parameters
----------
pipeline : `Pipeline`
    Pipeline definition, task names/classes and their configs.
inputCollections : `~collections.abc.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.

Definition at line 739 of file graphBuilder.py.

Member Data Documentation

◆ clobberExisting

lsst.pipe.base.graphBuilder.GraphBuilder.clobberExisting

Definition at line 737 of file graphBuilder.py.

◆ dimensions

lsst.pipe.base.graphBuilder.GraphBuilder.dimensions

Definition at line 735 of file graphBuilder.py.

◆ registry

lsst.pipe.base.graphBuilder.GraphBuilder.registry

Definition at line 734 of file graphBuilder.py.

◆ skipExisting

lsst.pipe.base.graphBuilder.GraphBuilder.skipExisting

Definition at line 736 of file graphBuilder.py.

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

python/lsst/pipe/base/graphBuilder.py

Public Member Functions

Public Attributes