lsst.pipe.base

The lsst.pipe.base module provides base classes for the task framework. Tasks package the algorithmic units of the LSST Science Pipelines. You can create, configure, and run tasks with their Python APIs. Some tasks, called pipeline tasks, can be packaged into data processing pipelines that you can run from the command line.

Changes

• lsst-pipe-base 27.0.0 (2024-05-29)
• lsst-pipe-base v26.0.0 (2023-09-22)
• lsst-pipe-base v25.0.0 (2023-02-28)
• lsst-pipe-base v24.0.0 (2022-08-26)
• lsst-pipe-base v23.0.1 (2022-02-02)
• lsst-pipe-base v23.0.0 (2021-12-10)
• lsst-pipe-base v22.0 (2021-04-01)

Using lsst.pipe.base

Overview

• Overview of the task framework

Developing tasks and pipeline tasks

• Creating a task
• Testing a pipeline task
• Creating a PipelineTask
• Retargeting subtasks of tasks

Developing Pipelines

• Creating a Pipeline
• Testing pipelines with mocks
• Working with Pipeline Graphs

Contributing

lsst.pipe.base is developed at https://github.com/lsst/pipe_base. You can find Jira issues for this module under the pipe_base component.

Python API reference

lsst.pipe.base Package

Functions

buildExecutionButler(butler, graph, ...[, ...])	Create an execution butler.
iterConnections(connections, connectionType)	Create an iterator over the selected connections type which yields all the defined connections of that type.

Classes

AdjustQuantumHelper(inputs, outputs[, ...])	Helper class for calling PipelineTaskConnections.adjustQuantum.
AlgorithmError	Exception that may be raised by PipelineTasks (and code they delegate to) in order to indicate a repeatable algorithmic failure that will not be addressed by retries.
AnnotatedPartialOutputsError	Exception that runQuantum raises when the (partial) outputs it has written contain information about their own incompleteness or degraded quality.
DeferredDatasetRef(datasetRef)	A wrapper class for DatasetRef that indicates that a PipelineTask should receive a DeferredDatasetHandle instead of an in-memory dataset.
ExecutionResources(*[, num_cores, max_mem, ...])	A description of the resources available to a running quantum.
GetDictMetadata(*args, **kwargs)	Protocol for objects that can extract a possibly-nested mapping of primitives.
GetSetDictMetadata(*args, **kwargs)	Protocol for objects that can assign and extract a possibly-nested mapping of primitives.
InMemoryDatasetHandle(inMemoryDataset, *[, ...])	An in-memory version of a DeferredDatasetHandle.
IncompatibleGraphError	Exception class to indicate that a lookup by NodeId is impossible due to incompatibilities.
InputQuantizedConnection(**kwargs)	Input variant of a QuantizedConnection.
Instrument([collection_prefix])	Base class for instrument-specific logic for the Gen3 Butler.
InvalidQuantumError	Exception that may be raised by PipelineTasks (and code they delegate to) in order to indicate logic bug or configuration problem.
LabelSpecifier([labels, begin, end])	A structure to specify a subset of labels to load.
NoWorkFound	An exception raised when a Quantum should not exist because there is no work for it to do.
NodeId(number, buildId)	Deprecated, this class is used with QuantumGraph save formats of 1 and 2 when unpicking objects and must be retained until those formats are considered unloadable.
ObservationDimensionPacker(data_id[, ...])	A DimensionPacker for visit+detector or exposure+detector.
ObservationDimensionPackerConfig(*args, **kw)	Config associated with a ObservationDimensionPacker.
OutputQuantizedConnection(**kwargs)	Output variant of a QuantizedConnection.
Pipeline(description)	A Pipeline is a representation of a series of tasks to run, and the configuration for those tasks.
PipelineTask(*[, config, log, initInputs])	Base class for all pipeline tasks.
PipelineTaskConfig(*args, **kw)	Configuration class for PipelineTask.
PipelineTaskConnections(*[, config])	PipelineTaskConnections is a class used to declare desired IO when a PipelineTask is run by an activator.
QgraphSummary(*, graphID[, cmdLine, ...])	Report for the QuantumGraph creation or reading.
QgraphTaskSummary(*[, taskLabel, numQuanta, ...])	Quanta information summarized for single PipelineTask.
QuantizedConnection(**kwargs)	A Namespace to map defined variable names of connections to the associated lsst.daf.butler.DatasetRef objects.
QuantumContext(butler, quantum, *[, resources])	A Butler-like class specialized for a single quantum along with context information that can influence how the task is executed.
QuantumGraph(quanta[, metadata, universe, ...])	QuantumGraph is a directed acyclic graph of QuantumNode objects.
QuantumNode(quantum, taskDef, nodeId)	Class representing a node in the quantum graph.
RepeatableQuantumError	Exception that may be raised by PipelineTasks (and code they delegate to) in order to indicate that a repeatable problem that will not be addressed by retries.
ScalarError	Exception raised when dataset type is configured as scalar but there are multiple data IDs in a Quantum for that dataset.
SetDictMetadata(*args, **kwargs)	Protocol for objects that can be assigned a possibly-nested dict of primitives.
Struct(**keyArgs)	A container to which you can add fields as attributes.
Task([config, name, parentTask, log])	Base class for data processing tasks.
TaskDef([taskName, config, taskClass, ...])	TaskDef is a collection of information about task needed by Pipeline.
TaskError	Use to report errors for which a traceback is not useful.
TaskFactory()	Abstract base class for task factory.
TaskMetadata(*[, scalars, arrays, metadata])	Dict-like object for storing task metadata.
UnprocessableDataError	Exception that will be subclassed and raised by Tasks to indicate a failure to process their inputs for some reason that is non-recoverable.
UpstreamFailureNoWorkFound	A specialization of NoWorkFound that indicates that an upstream task had a problem that was ignored (e.g.

Class Inheritance Diagram

digraph inheritance0e96621387 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Helper class that provides a standard way to create an ABC using"]; "AdjustQuantumHelper" [URL="../../../py-api/lsst.pipe.base.AdjustQuantumHelper.html#lsst.pipe.base.AdjustQuantumHelper",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Helper class for calling `PipelineTaskConnections.adjustQuantum`."]; "AlgorithmError" [URL="../../../py-api/lsst.pipe.base.AlgorithmError.html#lsst.pipe.base.AlgorithmError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Exception that may be raised by PipelineTasks (and code they delegate"]; "RepeatableQuantumError" -> "AlgorithmError" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ABC" -> "AlgorithmError" [arrowsize=0.5,style="setlinewidth(0.5)"]; "AnnotatedPartialOutputsError" [URL="../../../py-api/lsst.pipe.base.AnnotatedPartialOutputsError.html#lsst.pipe.base.AnnotatedPartialOutputsError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Exception that runQuantum raises when the (partial) outputs it has"]; "RepeatableQuantumError" -> "AnnotatedPartialOutputsError" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BaseModel" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Usage docs: https://docs.pydantic.dev/2.9/concepts/models/"]; "Config" [URL="../../../py-api/lsst.pex.config.Config.html#lsst.pex.config.Config",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for configuration (*config*) objects."]; "DeferredDatasetRef" [URL="../../../py-api/lsst.pipe.base.DeferredDatasetRef.html#lsst.pipe.base.DeferredDatasetRef",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A wrapper class for `~lsst.daf.butler.DatasetRef` that indicates that a"]; "DimensionPacker" [URL="../../../py-api/lsst.daf.butler.DimensionPacker.html#lsst.daf.butler.DimensionPacker",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Class for going from `DataCoordinate` to packed integer ID and back."]; "ExecutionResources" [URL="../../../py-api/lsst.pipe.base.ExecutionResources.html#lsst.pipe.base.ExecutionResources",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A description of the resources available to a running quantum."]; "Generic" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Abstract base class for generic types."]; "GetDictMetadata" [URL="../../../py-api/lsst.pipe.base.GetDictMetadata.html#lsst.pipe.base.GetDictMetadata",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Protocol for objects that can extract a possibly-nested mapping of"]; "Protocol" -> "GetDictMetadata" [arrowsize=0.5,style="setlinewidth(0.5)"]; "GetSetDictMetadata" [URL="../../../py-api/lsst.pipe.base.GetSetDictMetadata.html#lsst.pipe.base.GetSetDictMetadata",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Protocol for objects that can assign and extract a possibly-nested"]; "SetDictMetadata" -> "GetSetDictMetadata" [arrowsize=0.5,style="setlinewidth(0.5)"]; "GetDictMetadata" -> "GetSetDictMetadata" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Protocol" -> "GetSetDictMetadata" [arrowsize=0.5,style="setlinewidth(0.5)"]; "InMemoryDatasetHandle" [URL="../../../py-api/lsst.pipe.base.InMemoryDatasetHandle.html#lsst.pipe.base.InMemoryDatasetHandle",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An in-memory version of a `~lsst.daf.butler.DeferredDatasetHandle`."]; "IncompatibleGraphError" [URL="../../../py-api/lsst.pipe.base.IncompatibleGraphError.html#lsst.pipe.base.IncompatibleGraphError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Exception class to indicate that a lookup by NodeId is impossible due"]; "InputQuantizedConnection" [URL="../../../py-api/lsst.pipe.base.InputQuantizedConnection.html#lsst.pipe.base.InputQuantizedConnection",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Input variant of a `QuantizedConnection`."]; "QuantizedConnection" -> "InputQuantizedConnection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Instrument" [URL="../../../py-api/lsst.pipe.base.Instrument.html#lsst.pipe.base.Instrument",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for instrument-specific logic for the Gen3 Butler."]; "InvalidQuantumError" [URL="../../../py-api/lsst.pipe.base.InvalidQuantumError.html#lsst.pipe.base.InvalidQuantumError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Exception that may be raised by PipelineTasks (and code they delegate"]; "LabelSpecifier" [URL="../../../py-api/lsst.pipe.base.LabelSpecifier.html#lsst.pipe.base.LabelSpecifier",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A structure to specify a subset of labels to load."]; "NoWorkFound" [URL="../../../py-api/lsst.pipe.base.NoWorkFound.html#lsst.pipe.base.NoWorkFound",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An exception raised when a Quantum should not exist because there is no"]; "NodeId" [URL="../../../py-api/lsst.pipe.base.NodeId.html#lsst.pipe.base.NodeId",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Deprecated, this class is used with QuantumGraph save formats of"]; "ObservationDimensionPacker" [URL="../../../py-api/lsst.pipe.base.ObservationDimensionPacker.html#lsst.pipe.base.ObservationDimensionPacker",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A `DimensionPacker` for visit+detector or exposure+detector."]; "DimensionPacker" -> "ObservationDimensionPacker" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ObservationDimensionPackerConfig" [URL="../../../py-api/lsst.pipe.base.ObservationDimensionPackerConfig.html#lsst.pipe.base.ObservationDimensionPackerConfig",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Config associated with a `ObservationDimensionPacker`."]; "Config" -> "ObservationDimensionPackerConfig" [arrowsize=0.5,style="setlinewidth(0.5)"]; "OutputQuantizedConnection" [URL="../../../py-api/lsst.pipe.base.OutputQuantizedConnection.html#lsst.pipe.base.OutputQuantizedConnection",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Output variant of a `QuantizedConnection`."]; "QuantizedConnection" -> "OutputQuantizedConnection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Pipeline" [URL="../../../py-api/lsst.pipe.base.Pipeline.html#lsst.pipe.base.Pipeline",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A `Pipeline` is a representation of a series of tasks to run, and the"]; "PipelineTask" [URL="../../../py-api/lsst.pipe.base.PipelineTask.html#lsst.pipe.base.PipelineTask",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for all pipeline tasks."]; "Task" -> "PipelineTask" [arrowsize=0.5,style="setlinewidth(0.5)"]; "PipelineTaskConfig" [URL="../../../py-api/lsst.pipe.base.PipelineTaskConfig.html#lsst.pipe.base.PipelineTaskConfig",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Configuration class for `PipelineTask`."]; "Config" -> "PipelineTaskConfig" [arrowsize=0.5,style="setlinewidth(0.5)"]; "PipelineTaskConnections" [URL="../../../py-api/lsst.pipe.base.PipelineTaskConnections.html#lsst.pipe.base.PipelineTaskConnections",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="PipelineTaskConnections is a class used to declare desired IO when a"]; "Protocol" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Base class for protocol classes."]; "Generic" -> "Protocol" [arrowsize=0.5,style="setlinewidth(0.5)"]; "QgraphSummary" [URL="../../../py-api/lsst.pipe.base.QgraphSummary.html#lsst.pipe.base.QgraphSummary",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Report for the QuantumGraph creation or reading."]; "BaseModel" -> "QgraphSummary" [arrowsize=0.5,style="setlinewidth(0.5)"]; "QgraphTaskSummary" [URL="../../../py-api/lsst.pipe.base.QgraphTaskSummary.html#lsst.pipe.base.QgraphTaskSummary",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Quanta information summarized for single PipelineTask."]; "BaseModel" -> "QgraphTaskSummary" [arrowsize=0.5,style="setlinewidth(0.5)"]; "QuantizedConnection" [URL="../../../py-api/lsst.pipe.base.QuantizedConnection.html#lsst.pipe.base.QuantizedConnection",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A Namespace to map defined variable names of connections to the"]; "SimpleNamespace" -> "QuantizedConnection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "QuantumContext" [URL="../../../py-api/lsst.pipe.base.QuantumContext.html#lsst.pipe.base.QuantumContext",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A Butler-like class specialized for a single quantum along with"]; "QuantumGraph" [URL="../../../py-api/lsst.pipe.base.QuantumGraph.html#lsst.pipe.base.QuantumGraph",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="QuantumGraph is a directed acyclic graph of `QuantumNode` objects."]; "QuantumNode" [URL="../../../py-api/lsst.pipe.base.QuantumNode.html#lsst.pipe.base.QuantumNode",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Class representing a node in the quantum graph."]; "RepeatableQuantumError" [URL="../../../py-api/lsst.pipe.base.RepeatableQuantumError.html#lsst.pipe.base.RepeatableQuantumError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Exception that may be raised by PipelineTasks (and code they delegate"]; "ScalarError" [URL="../../../py-api/lsst.pipe.base.ScalarError.html#lsst.pipe.base.ScalarError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Exception raised when dataset type is configured as scalar"]; "SetDictMetadata" [URL="../../../py-api/lsst.pipe.base.SetDictMetadata.html#lsst.pipe.base.SetDictMetadata",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Protocol for objects that can be assigned a possibly-nested `dict` of"]; "Protocol" -> "SetDictMetadata" [arrowsize=0.5,style="setlinewidth(0.5)"]; "SimpleNamespace" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="A simple attribute-based namespace."]; "Struct" [URL="../../../py-api/lsst.pipe.base.Struct.html#lsst.pipe.base.Struct",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A container to which you can add fields as attributes."]; "SimpleNamespace" -> "Struct" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Task" [URL="../../../py-api/lsst.pipe.base.Task.html#lsst.pipe.base.Task",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for data processing tasks."]; "TaskDef" [URL="../../../py-api/lsst.pipe.base.TaskDef.html#lsst.pipe.base.TaskDef",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="TaskDef is a collection of information about task needed by Pipeline."]; "TaskError" [URL="../../../py-api/lsst.pipe.base.TaskError.html#lsst.pipe.base.TaskError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Use to report errors for which a traceback is not useful."]; "TaskFactory" [URL="../../../py-api/lsst.pipe.base.TaskFactory.html#lsst.pipe.base.TaskFactory",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Abstract base class for task factory."]; "TaskMetadata" [URL="../../../py-api/lsst.pipe.base.TaskMetadata.html#lsst.pipe.base.TaskMetadata",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Dict-like object for storing task metadata."]; "BaseModel" -> "TaskMetadata" [arrowsize=0.5,style="setlinewidth(0.5)"]; "UnprocessableDataError" [URL="../../../py-api/lsst.pipe.base.UnprocessableDataError.html#lsst.pipe.base.UnprocessableDataError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Exception that will be subclassed and raised by Tasks to indicate a"]; "RepeatableQuantumError" -> "UnprocessableDataError" [arrowsize=0.5,style="setlinewidth(0.5)"]; "UpstreamFailureNoWorkFound" [URL="../../../py-api/lsst.pipe.base.UpstreamFailureNoWorkFound.html#lsst.pipe.base.UpstreamFailureNoWorkFound",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A specialization of `NoWorkFound` that indicates that an upstream task"]; "NoWorkFound" -> "UpstreamFailureNoWorkFound" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

lsst.pipe.base.pipeline_graph Package

Functions

compare_packages(packages, new_packages)	Compare two versions of Packages.
log_config_mismatch(msg)	Log messages about configuration mismatch.

Classes

ConnectionTypeConsistencyError	Exception raised when the tasks in a pipeline graph use different (and incompatible) connection types for the same dataset type.
DatasetTypeNode(dataset_type, ...)	A node in a pipeline graph that represents a resolved dataset type.
DuplicateOutputError	Exception raised when multiple tasks in one pipeline produce the same output dataset type.
Edge(*, task_key, dataset_type_key, ...)	Base class for edges in a pipeline graph.
EdgesChangedError	Exception raised when the edges in one version of a pipeline graph are not consistent with those in another, but they were expected to be.
IncompatibleDatasetTypeError	Exception raised when the tasks in a pipeline graph define dataset types with the same name in incompatible ways, or when these are incompatible with the data repository definition.
NodeKey(node_type, name)	A special key type for nodes in networkx graphs.
NodeType(value[, names, module, qualname, ...])	Enumeration of the types of nodes in a PipelineGraph.
PipelineDataCycleError	Exception raised when a pipeline graph contains a cycle.
PipelineGraph(*[, description, universe, ...])	A graph representation of fully-configured pipeline.
PipelineGraphError	Base exception raised when there is a problem constructing or resolving a pipeline graph.
PipelineGraphExceptionSafetyError	Exception raised when a PipelineGraph method could not provide strong exception safety, and the graph may have been left in an inconsistent state.
PipelineGraphReadError	Exception raised when a serialized PipelineGraph cannot be read.
ReadEdge(dataset_type_key, task_key, *, ...)	Representation of an input connection (including init-inputs and prerequisites) in a pipeline graph.
TaskImportMode(value[, names, module, ...])	Enumeration of the ways to handle importing tasks when reading a serialized PipelineGraph.
TaskInitNode(key, *, inputs, outputs, ...[, ...])	A node in a pipeline graph that represents the construction of a PipelineTask.
TaskNode(key, init, *, prerequisite_inputs, ...)	A node in a pipeline graph that represents a labeled configuration of a PipelineTask.
TaskNotImportedError	Exception raised when accessing an attribute of a graph or graph node that is not available unless the task class has been imported and configured.
TaskSubset(parent_xgraph, label, members, ...)	A specialized set that represents a labeles subset of the tasks in a pipeline graph.
UnresolvedGraphError	Exception raised when an operation requires dimensions or dataset types to have been resolved, but they have not been.
WriteEdge(*, task_key, dataset_type_key, ...)	Representation of an output connection (including init-outputs) in a pipeline graph.

Class Inheritance Diagram

digraph inheritance2deb45d474 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Helper class that provides a standard way to create an ABC using"]; "Collection" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "Sized" -> "Collection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Iterable" -> "Collection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Container" -> "Collection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ConnectionTypeConsistencyError" [URL="../../../py-api/lsst.pipe.base.pipeline_graph.ConnectionTypeConsistencyError.html#lsst.pipe.base.pipeline_graph.ConnectionTypeConsistencyError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Exception raised when the tasks in a pipeline graph use different (and"]; "PipelineGraphError" -> "ConnectionTypeConsistencyError" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Container" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "DatasetTypeNode" [URL="../../../py-api/lsst.pipe.base.pipeline_graph.DatasetTypeNode.html#lsst.pipe.base.pipeline_graph.DatasetTypeNode",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A node in a pipeline graph that represents a resolved dataset type."]; "DuplicateOutputError" [URL="../../../py-api/lsst.pipe.base.pipeline_graph.DuplicateOutputError.html#lsst.pipe.base.pipeline_graph.DuplicateOutputError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Exception raised when multiple tasks in one pipeline produce the same"]; "PipelineGraphError" -> "DuplicateOutputError" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Edge" [URL="../../../py-api/lsst.pipe.base.pipeline_graph.Edge.html#lsst.pipe.base.pipeline_graph.Edge",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for edges in a pipeline graph."]; "ABC" -> "Edge" [arrowsize=0.5,style="setlinewidth(0.5)"]; "EdgesChangedError" [URL="../../../py-api/lsst.pipe.base.pipeline_graph.EdgesChangedError.html#lsst.pipe.base.pipeline_graph.EdgesChangedError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Exception raised when the edges in one version of a pipeline graph"]; "PipelineGraphError" -> "EdgesChangedError" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Enum" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Create a collection of name/value pairs."]; "IncompatibleDatasetTypeError" [URL="../../../py-api/lsst.pipe.base.pipeline_graph.IncompatibleDatasetTypeError.html#lsst.pipe.base.pipeline_graph.IncompatibleDatasetTypeError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Exception raised when the tasks in a pipeline graph define dataset types"]; "PipelineGraphError" -> "IncompatibleDatasetTypeError" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Iterable" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "MutableSet" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="A mutable set is a finite, iterable container."]; "Set" -> "MutableSet" [arrowsize=0.5,style="setlinewidth(0.5)"]; "NodeKey" [URL="../../../py-api/lsst.pipe.base.pipeline_graph.NodeKey.html#lsst.pipe.base.pipeline_graph.NodeKey",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A special key type for nodes in networkx graphs."]; "NodeType" [URL="../../../py-api/lsst.pipe.base.pipeline_graph.NodeType.html#lsst.pipe.base.pipeline_graph.NodeType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Enumeration of the types of nodes in a PipelineGraph."]; "Enum" -> "NodeType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "PipelineDataCycleError" [URL="../../../py-api/lsst.pipe.base.pipeline_graph.PipelineDataCycleError.html#lsst.pipe.base.pipeline_graph.PipelineDataCycleError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Exception raised when a pipeline graph contains a cycle."]; "PipelineGraphError" -> "PipelineDataCycleError" [arrowsize=0.5,style="setlinewidth(0.5)"]; "PipelineGraph" [URL="../../../py-api/lsst.pipe.base.pipeline_graph.PipelineGraph.html#lsst.pipe.base.pipeline_graph.PipelineGraph",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A graph representation of fully-configured pipeline."]; "PipelineGraphError" [URL="../../../py-api/lsst.pipe.base.pipeline_graph.PipelineGraphError.html#lsst.pipe.base.pipeline_graph.PipelineGraphError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base exception raised when there is a problem constructing or resolving"]; "PipelineGraphExceptionSafetyError" [URL="../../../py-api/lsst.pipe.base.pipeline_graph.PipelineGraphExceptionSafetyError.html#lsst.pipe.base.pipeline_graph.PipelineGraphExceptionSafetyError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Exception raised when a PipelineGraph method could not provide strong"]; "PipelineGraphError" -> "PipelineGraphExceptionSafetyError" [arrowsize=0.5,style="setlinewidth(0.5)"]; "PipelineGraphReadError" [URL="../../../py-api/lsst.pipe.base.pipeline_graph.PipelineGraphReadError.html#lsst.pipe.base.pipeline_graph.PipelineGraphReadError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Exception raised when a serialized PipelineGraph cannot be read."]; "PipelineGraphError" -> "PipelineGraphReadError" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ReadEdge" [URL="../../../py-api/lsst.pipe.base.pipeline_graph.ReadEdge.html#lsst.pipe.base.pipeline_graph.ReadEdge",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Representation of an input connection (including init-inputs and"]; "Edge" -> "ReadEdge" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Set" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="A set is a finite, iterable container."]; "Collection" -> "Set" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Sized" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "TaskImportMode" [URL="../../../py-api/lsst.pipe.base.pipeline_graph.TaskImportMode.html#lsst.pipe.base.pipeline_graph.TaskImportMode",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Enumeration of the ways to handle importing tasks when reading a"]; "Enum" -> "TaskImportMode" [arrowsize=0.5,style="setlinewidth(0.5)"]; "TaskInitNode" [URL="../../../py-api/lsst.pipe.base.pipeline_graph.TaskInitNode.html#lsst.pipe.base.pipeline_graph.TaskInitNode",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A node in a pipeline graph that represents the construction of a"]; "TaskNode" [URL="../../../py-api/lsst.pipe.base.pipeline_graph.TaskNode.html#lsst.pipe.base.pipeline_graph.TaskNode",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A node in a pipeline graph that represents a labeled configuration of a"]; "TaskNotImportedError" [URL="../../../py-api/lsst.pipe.base.pipeline_graph.TaskNotImportedError.html#lsst.pipe.base.pipeline_graph.TaskNotImportedError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Exception raised when accessing an attribute of a graph or graph node"]; "PipelineGraphError" -> "TaskNotImportedError" [arrowsize=0.5,style="setlinewidth(0.5)"]; "TaskSubset" [URL="../../../py-api/lsst.pipe.base.pipeline_graph.TaskSubset.html#lsst.pipe.base.pipeline_graph.TaskSubset",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A specialized set that represents a labeles subset of the tasks in a"]; "MutableSet" -> "TaskSubset" [arrowsize=0.5,style="setlinewidth(0.5)"]; "UnresolvedGraphError" [URL="../../../py-api/lsst.pipe.base.pipeline_graph.UnresolvedGraphError.html#lsst.pipe.base.pipeline_graph.UnresolvedGraphError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Exception raised when an operation requires dimensions or dataset types"]; "PipelineGraphError" -> "UnresolvedGraphError" [arrowsize=0.5,style="setlinewidth(0.5)"]; "WriteEdge" [URL="../../../py-api/lsst.pipe.base.pipeline_graph.WriteEdge.html#lsst.pipe.base.pipeline_graph.WriteEdge",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Representation of an output connection (including init-outputs) in a"]; "Edge" -> "WriteEdge" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

lsst.pipe.base.testUtils Module

Functions

assertValidInitOutput(task)	Test that a constructed task conforms to its own init-connections.
assertValidOutput(task, result)	Test that the output of a call to run conforms to its own connections.
getInitInputs(butler, config)	Return the initInputs object that would have been passed to a PipelineTask constructor.
lintConnections(connections, *[, ...])	Inspect a connections class for common errors.
makeQuantum(task, butler, dataId, ioDataIds)	Create a Quantum for a particular data ID(s).
runTestQuantum(task, butler, quantum[, mockRun])	Run a PipelineTask on a Quantum.

lsst.pipe.base.connectionTypes Module

Module defining connection types to be used within a PipelineTaskConnections class.

Classes

InitInput(name, storageClass[, doc, ...])	Connection for initInput dataset.
InitOutput(name, storageClass[, doc, ...])	Connection for initOutput dataset.
Input(name, storageClass[, doc, multiple, ...])	Class used for declaring PipelineTask input connections.
PrerequisiteInput(name, storageClass[, doc, ...])	Class used for declaring PipelineTask prerequisite connections.
Output(name, storageClass[, doc, multiple, ...])	Connection for output dataset.
BaseConnection(name, storageClass[, doc, ...])	Base class used for declaring PipelineTask connections.

Class Inheritance Diagram

digraph inheritance465200a9d7 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "BaseConnection" [URL="../../../py-api/lsst.pipe.base.connectionTypes.BaseConnection.html#lsst.pipe.base.connectionTypes.BaseConnection",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class used for declaring `PipelineTask` connections."]; "BaseInput" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Class used for declaring PipelineTask input connections."]; "DimensionedConnection" -> "BaseInput" [arrowsize=0.5,style="setlinewidth(0.5)"]; "DimensionedConnection" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Class used for declaring PipelineTask connections that includes"]; "BaseConnection" -> "DimensionedConnection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "InitInput" [URL="../../../py-api/lsst.pipe.base.connectionTypes.InitInput.html#lsst.pipe.base.connectionTypes.InitInput",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Connection for initInput dataset."]; "BaseConnection" -> "InitInput" [arrowsize=0.5,style="setlinewidth(0.5)"]; "InitOutput" [URL="../../../py-api/lsst.pipe.base.connectionTypes.InitOutput.html#lsst.pipe.base.connectionTypes.InitOutput",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Connection for initOutput dataset."]; "BaseConnection" -> "InitOutput" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Input" [URL="../../../py-api/lsst.pipe.base.connectionTypes.Input.html#lsst.pipe.base.connectionTypes.Input",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Class used for declaring PipelineTask input connections."]; "BaseInput" -> "Input" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Output" [URL="../../../py-api/lsst.pipe.base.connectionTypes.Output.html#lsst.pipe.base.connectionTypes.Output",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Connection for output dataset."]; "DimensionedConnection" -> "Output" [arrowsize=0.5,style="setlinewidth(0.5)"]; "PrerequisiteInput" [URL="../../../py-api/lsst.pipe.base.connectionTypes.PrerequisiteInput.html#lsst.pipe.base.connectionTypes.PrerequisiteInput",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Class used for declaring PipelineTask prerequisite connections."]; "BaseInput" -> "PrerequisiteInput" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

lsst.pipe.base.pipelineIR Module

Classes

ConfigIR(python, dataId, file, rest)	Intermediate representation of configurations read from a pipeline yaml file.
ContractError	An exception that is raised when a pipeline contract is not satisfied.
ContractIR(contract[, msg])	Intermediate representation of configuration contracts read from a pipeline yaml file.
ImportIR(location, include, exclude, ...)	An intermediate representation of imported pipelines.
LabeledSubset(label, subset, description)	Intermediate representation of named subset of task labels read from a pipeline yaml file.
ParametersIR(mapping)	Intermediate representation of parameters that are global to a pipeline.
PipelineIR(loaded_yaml)	Intermediate representation of a pipeline definition.
TaskIR(label, klass[, config])	Intermediate representation of tasks read from a pipeline yaml file.

Class Inheritance Diagram

digraph inheritance6ee3b34c0d { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ConfigIR" [URL="../../../py-api/lsst.pipe.base.pipelineIR.ConfigIR.html#lsst.pipe.base.pipelineIR.ConfigIR",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Intermediate representation of configurations read from a pipeline yaml"]; "ContractError" [URL="../../../py-api/lsst.pipe.base.pipelineIR.ContractError.html#lsst.pipe.base.pipelineIR.ContractError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An exception that is raised when a pipeline contract is not"]; "ContractIR" [URL="../../../py-api/lsst.pipe.base.pipelineIR.ContractIR.html#lsst.pipe.base.pipelineIR.ContractIR",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Intermediate representation of configuration contracts read from a"]; "ImportIR" [URL="../../../py-api/lsst.pipe.base.pipelineIR.ImportIR.html#lsst.pipe.base.pipelineIR.ImportIR",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An intermediate representation of imported pipelines."]; "LabeledSubset" [URL="../../../py-api/lsst.pipe.base.pipelineIR.LabeledSubset.html#lsst.pipe.base.pipelineIR.LabeledSubset",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Intermediate representation of named subset of task labels read from"]; "ParametersIR" [URL="../../../py-api/lsst.pipe.base.pipelineIR.ParametersIR.html#lsst.pipe.base.pipelineIR.ParametersIR",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Intermediate representation of parameters that are global to a pipeline."]; "PipelineIR" [URL="../../../py-api/lsst.pipe.base.pipelineIR.PipelineIR.html#lsst.pipe.base.pipelineIR.PipelineIR",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Intermediate representation of a pipeline definition."]; "TaskIR" [URL="../../../py-api/lsst.pipe.base.pipelineIR.TaskIR.html#lsst.pipe.base.pipelineIR.TaskIR",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Intermediate representation of tasks read from a pipeline yaml file."]; }

lsst.pipe.base.tests.mocks Package

A system for replacing the tasks in a pipeline with mocks that just read and write trivial datasets.

See Testing pipelines with mocks for details.

Functions

get_mock_name(original)	Return the name of the mock storage class, dataset type, or task label for the given original name.
get_original_name(mock)	Return the name of the original storage class, dataset type, or task label that corresponds to the given mock name.
is_mock_name(name)	Return whether the given name is that of a mock storage class, dataset type, or task label.
mock_pipeline_graph(original_graph[, ...])	Create mocks for a full pipeline graph.

Classes

ConvertedUnmockedDataset(*, original_type)	A marker class that represents a conversion from a regular in-memory dataset to a mock storage class.
DataIdMatch(expression)	Class that can match DataId against the user-defined string expression.
DynamicConnectionConfig(*args, **kw)	A config class that defines a completely dynamic connection.
DynamicTestPipelineTask(*, config, ...)	A test-utility implementation of PipelineTask with dimensions and connections determined wholly from configuration.
DynamicTestPipelineTaskConfig(*args, **kw)	Configuration for DynamicTestPipelineTask.
ForcedFailure(condition[, exception_type, ...])	Information about an exception that should be raised by one or more quanta.
MockDataset(*, dataset_id, dataset_type, ...)	The in-memory dataset type used by MockStorageClass.
MockDatasetQuantum(*, task_label, data_id, ...)	Description of the quantum that produced a mock dataset.
MockPipelineTask(*, config, initInputs, **kwargs)	A test-utility implementation of PipelineTask with connections generated by mocking those of a real task.
MockPipelineTaskConfig(*args, **kw)	Configuration class for MockPipelineTask.
MockStorageClass(original[, factory])	A reimplementation of lsst.daf.butler.StorageClass for mock datasets.
MockStorageClassDelegate(storageClass)	Implementation of the StorageClassDelegate interface for mock datasets.

Class Inheritance Diagram

digraph inheritanceacc4f1f82d { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "BaseModel" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Usage docs: https://docs.pydantic.dev/2.9/concepts/models/"]; "BaseTestPipelineTask" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="A base class for test-utility `PipelineTask` classes that read and write"]; "PipelineTask" -> "BaseTestPipelineTask" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BaseTestPipelineTaskConfig" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "PipelineTaskConfig" -> "BaseTestPipelineTaskConfig" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Config" [URL="../../../py-api/lsst.pex.config.Config.html#lsst.pex.config.Config",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for configuration (*config*) objects."]; "ConvertedUnmockedDataset" [URL="../../../py-api/lsst.pipe.base.tests.mocks.ConvertedUnmockedDataset.html#lsst.pipe.base.tests.mocks.ConvertedUnmockedDataset",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A marker class that represents a conversion from a regular in-memory"]; "BaseModel" -> "ConvertedUnmockedDataset" [arrowsize=0.5,style="setlinewidth(0.5)"]; "DataIdMatch" [URL="../../../py-api/lsst.pipe.base.tests.mocks.DataIdMatch.html#lsst.pipe.base.tests.mocks.DataIdMatch",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Class that can match DataId against the user-defined string expression."]; "DynamicConnectionConfig" [URL="../../../py-api/lsst.pipe.base.tests.mocks.DynamicConnectionConfig.html#lsst.pipe.base.tests.mocks.DynamicConnectionConfig",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A config class that defines a completely dynamic connection."]; "Config" -> "DynamicConnectionConfig" [arrowsize=0.5,style="setlinewidth(0.5)"]; "DynamicTestPipelineTask" [URL="../../../py-api/lsst.pipe.base.tests.mocks.DynamicTestPipelineTask.html#lsst.pipe.base.tests.mocks.DynamicTestPipelineTask",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A test-utility implementation of `PipelineTask` with dimensions and"]; "BaseTestPipelineTask" -> "DynamicTestPipelineTask" [arrowsize=0.5,style="setlinewidth(0.5)"]; "DynamicTestPipelineTaskConfig" [URL="../../../py-api/lsst.pipe.base.tests.mocks.DynamicTestPipelineTaskConfig.html#lsst.pipe.base.tests.mocks.DynamicTestPipelineTaskConfig",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Configuration for DynamicTestPipelineTask."]; "BaseTestPipelineTaskConfig" -> "DynamicTestPipelineTaskConfig" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ForcedFailure" [URL="../../../py-api/lsst.pipe.base.tests.mocks.ForcedFailure.html#lsst.pipe.base.tests.mocks.ForcedFailure",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Information about an exception that should be raised by one or more"]; "MockDataset" [URL="../../../py-api/lsst.pipe.base.tests.mocks.MockDataset.html#lsst.pipe.base.tests.mocks.MockDataset",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The in-memory dataset type used by `MockStorageClass`."]; "BaseModel" -> "MockDataset" [arrowsize=0.5,style="setlinewidth(0.5)"]; "MockDatasetQuantum" [URL="../../../py-api/lsst.pipe.base.tests.mocks.MockDatasetQuantum.html#lsst.pipe.base.tests.mocks.MockDatasetQuantum",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Description of the quantum that produced a mock dataset."]; "BaseModel" -> "MockDatasetQuantum" [arrowsize=0.5,style="setlinewidth(0.5)"]; "MockPipelineTask" [URL="../../../py-api/lsst.pipe.base.tests.mocks.MockPipelineTask.html#lsst.pipe.base.tests.mocks.MockPipelineTask",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A test-utility implementation of `PipelineTask` with connections"]; "BaseTestPipelineTask" -> "MockPipelineTask" [arrowsize=0.5,style="setlinewidth(0.5)"]; "MockPipelineTaskConfig" [URL="../../../py-api/lsst.pipe.base.tests.mocks.MockPipelineTaskConfig.html#lsst.pipe.base.tests.mocks.MockPipelineTaskConfig",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Configuration class for `MockPipelineTask`."]; "BaseTestPipelineTaskConfig" -> "MockPipelineTaskConfig" [arrowsize=0.5,style="setlinewidth(0.5)"]; "MockStorageClass" [URL="../../../py-api/lsst.pipe.base.tests.mocks.MockStorageClass.html#lsst.pipe.base.tests.mocks.MockStorageClass",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A reimplementation of `lsst.daf.butler.StorageClass` for mock datasets."]; "StorageClass" -> "MockStorageClass" [arrowsize=0.5,style="setlinewidth(0.5)"]; "MockStorageClassDelegate" [URL="../../../py-api/lsst.pipe.base.tests.mocks.MockStorageClassDelegate.html#lsst.pipe.base.tests.mocks.MockStorageClassDelegate",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Implementation of the StorageClassDelegate interface for mock datasets."]; "StorageClassDelegate" -> "MockStorageClassDelegate" [arrowsize=0.5,style="setlinewidth(0.5)"]; "PipelineTask" [URL="../../../py-api/lsst.pipe.base.PipelineTask.html#lsst.pipe.base.PipelineTask",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for all pipeline tasks."]; "Task" -> "PipelineTask" [arrowsize=0.5,style="setlinewidth(0.5)"]; "PipelineTaskConfig" [URL="../../../py-api/lsst.pipe.base.PipelineTaskConfig.html#lsst.pipe.base.PipelineTaskConfig",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Configuration class for `PipelineTask`."]; "Config" -> "PipelineTaskConfig" [arrowsize=0.5,style="setlinewidth(0.5)"]; "StorageClass" [URL="../../../py-api/lsst.daf.butler.StorageClass.html#lsst.daf.butler.StorageClass",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Class describing how a label maps to a particular Python type."]; "StorageClassDelegate" [URL="../../../py-api/lsst.daf.butler.StorageClassDelegate.html#lsst.daf.butler.StorageClassDelegate",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Delegate class for StorageClass components and parameters."]; "Task" [URL="../../../py-api/lsst.pipe.base.Task.html#lsst.pipe.base.Task",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for data processing tasks."]; }

lsst.pipe.base.execution_reports Module

Functions

lookup_quantum_data_id(graph_uri, nodes)

Look up a dataId from a quantum graph and a list of quantum graph nodeIDs.

Classes

QuantumGraphExecutionReport(tasks, ...)	A report on the execution of a quantum graph.
TaskExecutionReport(failed, ...)	A report on the status and content of a task in an executed quantum graph.
DatasetTypeExecutionReport(failed, ...)	A report on the number of produced datasets as well as the status of missing datasets based on metadata.

Class Inheritance Diagram

digraph inheritance4ff5238c02 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "DatasetTypeExecutionReport" [URL="../../../py-api/lsst.pipe.base.execution_reports.DatasetTypeExecutionReport.html#lsst.pipe.base.execution_reports.DatasetTypeExecutionReport",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A report on the number of produced datasets as well as the status of"]; "QuantumGraphExecutionReport" [URL="../../../py-api/lsst.pipe.base.execution_reports.QuantumGraphExecutionReport.html#lsst.pipe.base.execution_reports.QuantumGraphExecutionReport",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A report on the execution of a quantum graph."]; "TaskExecutionReport" [URL="../../../py-api/lsst.pipe.base.execution_reports.TaskExecutionReport.html#lsst.pipe.base.execution_reports.TaskExecutionReport",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A report on the status and content of a task in an executed quantum"]; }

QuantumGraph generation API reference

lsst.pipe.base.quantum_graph_builder Module

The base class for the QuantumGraph-generation algorithm and various helper classes.

Classes

QuantumGraphBuilder(pipeline_graph, butler, *)	An abstract base class for building QuantumGraph objects from a pipeline.
ExistingDatasets(inputs, ...)	Struct that holds the results of dataset queries for QuantumGraphBuilder.
QuantumGraphBuilderError	Base class for exceptions generated by QuantumGraphBuilder.
OutputExistsError	Exception generated when output datasets already exist.
PrerequisiteMissingError	Exception generated when a prerequisite dataset does not exist.

Class Inheritance Diagram

digraph inheritance0089dae425 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Helper class that provides a standard way to create an ABC using"]; "ExistingDatasets" [URL="../../../py-api/lsst.pipe.base.quantum_graph_builder.ExistingDatasets.html#lsst.pipe.base.quantum_graph_builder.ExistingDatasets",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Struct that holds the results of dataset queries for"]; "OutputExistsError" [URL="../../../py-api/lsst.pipe.base.quantum_graph_builder.OutputExistsError.html#lsst.pipe.base.quantum_graph_builder.OutputExistsError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Exception generated when output datasets already exist."]; "QuantumGraphBuilderError" -> "OutputExistsError" [arrowsize=0.5,style="setlinewidth(0.5)"]; "PrerequisiteMissingError" [URL="../../../py-api/lsst.pipe.base.quantum_graph_builder.PrerequisiteMissingError.html#lsst.pipe.base.quantum_graph_builder.PrerequisiteMissingError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Exception generated when a prerequisite dataset does not exist."]; "QuantumGraphBuilderError" -> "PrerequisiteMissingError" [arrowsize=0.5,style="setlinewidth(0.5)"]; "QuantumGraphBuilder" [URL="../../../py-api/lsst.pipe.base.quantum_graph_builder.QuantumGraphBuilder.html#lsst.pipe.base.quantum_graph_builder.QuantumGraphBuilder",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An abstract base class for building `QuantumGraph` objects from a"]; "ABC" -> "QuantumGraphBuilder" [arrowsize=0.5,style="setlinewidth(0.5)"]; "QuantumGraphBuilderError" [URL="../../../py-api/lsst.pipe.base.quantum_graph_builder.QuantumGraphBuilderError.html#lsst.pipe.base.quantum_graph_builder.QuantumGraphBuilderError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for exceptions generated by QuantumGraphBuilder."]; }

lsst.pipe.base.quantum_graph_skeleton Module

An under-construction version of QuantumGraph and various helper classes.

Classes

QuantumGraphSkeleton(task_labels)	An under-construction quantum graph.
QuantumKey(task_label, data_id_values[, is_task])	Identifier type for quantum keys in a QuantumGraphSkeleton.
TaskInitKey(task_label[, is_task])	Identifier type for task init keys in a QuantumGraphSkeleton.
DatasetKey(parent_dataset_type_name, ...[, ...])	Identifier type for dataset keys in a QuantumGraphSkeleton.
PrerequisiteDatasetKey(...[, is_task, ...])	Identifier type for prerequisite dataset keys in a QuantumGraphSkeleton.

Class Inheritance Diagram

digraph inheritance386479d635 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "DatasetKey" [URL="../../../py-api/lsst.pipe.base.quantum_graph_skeleton.DatasetKey.html#lsst.pipe.base.quantum_graph_skeleton.DatasetKey",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Identifier type for dataset keys in a `QuantumGraphSkeleton`."]; "PrerequisiteDatasetKey" [URL="../../../py-api/lsst.pipe.base.quantum_graph_skeleton.PrerequisiteDatasetKey.html#lsst.pipe.base.quantum_graph_skeleton.PrerequisiteDatasetKey",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Identifier type for prerequisite dataset keys in a"]; "QuantumGraphSkeleton" [URL="../../../py-api/lsst.pipe.base.quantum_graph_skeleton.QuantumGraphSkeleton.html#lsst.pipe.base.quantum_graph_skeleton.QuantumGraphSkeleton",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An under-construction quantum graph."]; "QuantumKey" [URL="../../../py-api/lsst.pipe.base.quantum_graph_skeleton.QuantumKey.html#lsst.pipe.base.quantum_graph_skeleton.QuantumKey",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Identifier type for quantum keys in a `QuantumGraphSkeleton`."]; "TaskInitKey" [URL="../../../py-api/lsst.pipe.base.quantum_graph_skeleton.TaskInitKey.html#lsst.pipe.base.quantum_graph_skeleton.TaskInitKey",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Identifier type for task init keys in a `QuantumGraphSkeleton`."]; }

lsst.pipe.base.prerequisite_helpers Module

Helper classes for finding prerequisite input datasets during QuantumGraph generation.

Classes

SkyPixBoundsBuilder()	A base class for objects that accumulate the appropriate spatial bounds for a quantum.
PrerequisiteFinder(edge, bounds, pipeline_graph)	A QuantumGraph-generation helper class that manages the searches for a prerequisite input connection.
PrerequisiteBounds(task_node, ...)	A QuantumGraph-generation helper class that manages the spatial and temporal bounds of a tasks' quanta, for the purpose of finding prerequisite inputs.
TimespanBuilder()	A base class for objects that accumulate the appropriate timespan for a quantum.
PrerequisiteInfo(task_node, pipeline_graph)	A QuantumGraph-generation helper class that manages the searches for all prerequisite input connections for a task.

Class Inheritance Diagram

digraph inheritance24074eba55 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Helper class that provides a standard way to create an ABC using"]; "PrerequisiteBounds" [URL="../../../py-api/lsst.pipe.base.prerequisite_helpers.PrerequisiteBounds.html#lsst.pipe.base.prerequisite_helpers.PrerequisiteBounds",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A QuantumGraph-generation helper class that manages the spatial and"]; "PrerequisiteFinder" [URL="../../../py-api/lsst.pipe.base.prerequisite_helpers.PrerequisiteFinder.html#lsst.pipe.base.prerequisite_helpers.PrerequisiteFinder",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A QuantumGraph-generation helper class that manages the searches for a"]; "PrerequisiteInfo" [URL="../../../py-api/lsst.pipe.base.prerequisite_helpers.PrerequisiteInfo.html#lsst.pipe.base.prerequisite_helpers.PrerequisiteInfo",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A QuantumGraph-generation helper class that manages the searches for all"]; "SkyPixBoundsBuilder" [URL="../../../py-api/lsst.pipe.base.prerequisite_helpers.SkyPixBoundsBuilder.html#lsst.pipe.base.prerequisite_helpers.SkyPixBoundsBuilder",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A base class for objects that accumulate the appropriate spatial bounds"]; "ABC" -> "SkyPixBoundsBuilder" [arrowsize=0.5,style="setlinewidth(0.5)"]; "TimespanBuilder" [URL="../../../py-api/lsst.pipe.base.prerequisite_helpers.TimespanBuilder.html#lsst.pipe.base.prerequisite_helpers.TimespanBuilder",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A base class for objects that accumulate the appropriate timespan"]; "ABC" -> "TimespanBuilder" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

lsst.pipe.base.all_dimensions_quantum_graph_builder Module

The standard, general-purpose implementation of the QuantumGraph-generation algorithm.

Classes

AllDimensionsQuantumGraphBuilder(...)

An implementation of QuantumGraphBuilder that uses a single large query for data IDs covering all dimensions in the pipeline.

Class Inheritance Diagram

digraph inheritance9ff99b6ec0 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Helper class that provides a standard way to create an ABC using"]; "AllDimensionsQuantumGraphBuilder" [URL="../../../py-api/lsst.pipe.base.all_dimensions_quantum_graph_builder.AllDimensionsQuantumGraphBuilder.html#lsst.pipe.base.all_dimensions_quantum_graph_builder.AllDimensionsQuantumGraphBuilder",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An implementation of `QuantumGraphBuilder` that uses a single large"]; "QuantumGraphBuilder" -> "AllDimensionsQuantumGraphBuilder" [arrowsize=0.5,style="setlinewidth(0.5)"]; "QuantumGraphBuilder" [URL="../../../py-api/lsst.pipe.base.quantum_graph_builder.QuantumGraphBuilder.html#lsst.pipe.base.quantum_graph_builder.QuantumGraphBuilder",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An abstract base class for building `QuantumGraph` objects from a"]; "ABC" -> "QuantumGraphBuilder" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

lsst.pipe.base._datasetQueryConstraints Module

Symbols defined in this package should be imported from all_dimensions_quantum_graph_builder instead; it only appears in the docs due to limitations in Sphinx.

Classes

DatasetQueryConstraintVariant()

Base for all the valid variants for controlling constraining graph building queries based on dataset type existence.

Class Inheritance Diagram

digraph inheritance4898ce62fd { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "DatasetQueryConstraintVariant" [URL="../../../py-api/lsst.pipe.base._datasetQueryConstraints.DatasetQueryConstraintVariant.html#lsst.pipe.base._datasetQueryConstraints.DatasetQueryConstraintVariant",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base for all the valid variants for controlling"]; "Iterable" -> "DatasetQueryConstraintVariant" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Protocol" -> "DatasetQueryConstraintVariant" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Generic" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Abstract base class for generic types."]; "Iterable" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "Protocol" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Base class for protocol classes."]; "Generic" -> "Protocol" [arrowsize=0.5,style="setlinewidth(0.5)"]; }