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 791 of file graphBuilder.py.

Constructor & Destructor Documentation

◆ init()

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

Definition at line 804 of file graphBuilder.py.

     def __init__(self, registry, skipExisting=True):
         self.registry = registry
         self.dimensions = registry.dimensions
         self.skipExisting = skipExisting
  

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 809 of file graphBuilder.py.

     def 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.
         """
         scaffolding = _PipelineScaffolding(pipeline, registry=self.registry)
         if not collections and (scaffolding.initInputs or scaffolding.inputs or scaffolding.prerequisites):
             raise ValueError("Pipeline requires input datasets but no input collections provided.")
         instrument = pipeline.getInstrument()
         if isinstance(instrument, str):
             instrument = doImport(instrument)
         if instrument is not None:
             dataId = DataCoordinate.standardize(instrument=instrument.getName(),
                                                 universe=self.registry.dimensions)
         else:
             dataId = DataCoordinate.makeEmpty(self.registry.dimensions)
         with scaffolding.connectDataIds(self.registry, collections, userQuery, dataId) as commonDataIds:
             scaffolding.resolveDatasetRefs(self.registry, collections, run, commonDataIds,
                                            skipExisting=self.skipExisting)
         return scaffolding.makeQuantumGraph()

Member Data Documentation

◆ dimensions

lsst.pipe.base.graphBuilder.GraphBuilder.dimensions

Definition at line 806 of file graphBuilder.py.

◆ registry

lsst.pipe.base.graphBuilder.GraphBuilder.registry

Definition at line 805 of file graphBuilder.py.

◆ skipExisting

lsst.pipe.base.graphBuilder.GraphBuilder.skipExisting

Definition at line 807 of file graphBuilder.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.4.3/Linux64/pipe_base/22.0.1+94e66cc9ed/python/lsst/pipe/base/graphBuilder.py

Public Member Functions

Public Attributes