lsst.pipe.base  18.0.0-1-g3877d06
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, taskFactory, registry, skipExisting=True)
 
def makeGraph (self, pipeline, originInfo, userQuery)
 

Public Attributes

 taskFactory
 
 registry
 
 dimensions
 
 skipExisting
 

Detailed Description

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

Parameters
----------
taskFactory : `TaskFactory`
    Factory object used to load/instantiate PipelineTasks
registry : `~lsst.daf.butler.Registry`
    Data butler instance.
skipExisting : `bool`, optional
    If ``True`` (default) then Quantum is not created if all its outputs
    already exist, otherwise exception is raised.

Definition at line 85 of file graphBuilder.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 101 of file graphBuilder.py.

Member Function Documentation

◆ makeGraph()

def lsst.pipe.base.graphBuilder.GraphBuilder.makeGraph (   self,
  pipeline,
  originInfo,
  userQuery 
)
Create execution graph for a pipeline.

Parameters
----------
pipeline : `Pipeline`
    Pipeline definition, task names/classes and their configs.
originInfo : `~lsst.daf.butler.DatasetOriginInfo`
    Object which provides names of the input/output collections.
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 129 of file graphBuilder.py.

Member Data Documentation

◆ dimensions

lsst.pipe.base.graphBuilder.GraphBuilder.dimensions

Definition at line 104 of file graphBuilder.py.

◆ registry

lsst.pipe.base.graphBuilder.GraphBuilder.registry

Definition at line 103 of file graphBuilder.py.

◆ skipExisting

lsst.pipe.base.graphBuilder.GraphBuilder.skipExisting

Definition at line 105 of file graphBuilder.py.

◆ taskFactory

lsst.pipe.base.graphBuilder.GraphBuilder.taskFactory

Definition at line 102 of file graphBuilder.py.


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