lsst.pipe.base  20.0.0-27-g71224ee+38e0695d12
Public Member Functions | Public Attributes | List of all members
lsst.pipe.base.graphBuilder.GraphBuilder Class Reference
Inheritance diagram for lsst.pipe.base.graphBuilder.GraphBuilder:

Public Member Functions

def __init__ (self, registry, skipExisting=True)
 
def makeGraph (self, pipeline, collections, run, userQuery)
 

Public Attributes

 registry
 
 dimensions
 
 skipExisting
 

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.

Definition at line 875 of file graphBuilder.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 888 of file graphBuilder.py.

Member Function Documentation

◆ makeGraph()

def lsst.pipe.base.graphBuilder.GraphBuilder.makeGraph (   self,
  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 `~lsst.daf.butler.CollectionType.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.

Definition at line 893 of file graphBuilder.py.

Member Data Documentation

◆ dimensions

lsst.pipe.base.graphBuilder.GraphBuilder.dimensions

Definition at line 890 of file graphBuilder.py.

◆ registry

lsst.pipe.base.graphBuilder.GraphBuilder.registry

Definition at line 889 of file graphBuilder.py.

◆ skipExisting

lsst.pipe.base.graphBuilder.GraphBuilder.skipExisting

Definition at line 891 of file graphBuilder.py.


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