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 command-line tasks, are also packaged into data processing pipelines that you can run from the command line.
Changes¶
Using lsst.pipe.base¶
Overview¶
Using command-line tasks¶
- Using Butler data repositories and reruns with command-line tasks
- Specifying data IDs with command-line tasks
- Configuring command-line tasks
- Retargeting subtasks of command-line tasks
- Working with provenance checks in command-line tasks
- Logging with command-line tasks
- Parallel processing with command-line tasks
- Command-line task argument reference
Developing tasks and command-line tasks¶
Developing Pipelines¶
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 is a function that is responsible for exporting input |
|
Get a logger compatible with LSST usage. |
|
Creates an iterator over the selected connections type which yields all the defined connections of that type. |
|
Log timer information to |
|
Decorator to measure duration of a method. |
Classes¶
|
Helper class for calling |
|
Argument parser for command-line tasks that is based on |
|
A |
|
A Butler-like class specialized for a single quantum |
|
Base class for command-line tasks: tasks that may be executed from the command-line. |
|
Dataset type specified by a config parameter. |
|
argparse action to load config overrides from one or more files. |
|
argparse action callback to override config parameters using name=value pairs from the command-line. |
|
Container for data IDs and associated data references. |
|
Dataset type specified by a command-line argument. |
|
A wrapper class for |
|
GraphBuilder class is responsible for building task execution graph from a Pipeline. |
Exception class to indicate that a lookup by NodeId is impossible due to incompatibilities |
|
|
|
|
|
|
Base class for instrument-specific logic for the Gen3 Butler. |
Exception that may be raised by PipelineTasks (and code they delegate to) in order to indicate logic bug or configuration problem. |
|
|
A structure to specify a subset of labels to load |
|
A |
An exception raised when a Quantum should not exist because there is no work for it to do. |
|
|
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. |
|
|
|
A |
|
An immutable struct that classifies the dataset types used in a |
|
Base class for all pipeline tasks. |
|
Configuration class for |
|
PipelineTaskConnections is a class used to declare desired IO when a PipelineTask is run by an activator |
|
QuantumGraph is a directed acyclic graph of |
|
This class represents a node in the quantum graph. |
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. |
|
|
Configuration for resource requirements. |
Exception raised when dataset type is configured as scalar but there are multiple data IDs in a Quantum for that dataset. |
|
|
A container to which you can add fields as attributes. |
|
Base class for data processing tasks. |
|
An immutable struct that extracts and classifies the dataset types used by a |
|
TaskDef is a collection of information about task needed by Pipeline. |
Use to report errors for which a traceback is not useful. |
|
Abstract base class for task factory. |
|
|
Dict-like object for storing task metadata. |
|
Run a command-line task, using |
Class Inheritance Diagram¶
lsst.pipe.base.testUtils Module¶
Functions¶
|
Test that a constructed task conforms to its own init-connections. |
|
Test that the output of a call to |
|
Return the initInputs object that would have been passed to a |
|
Inspect a connections class for common errors. |
|
Create a Quantum for a particular data ID(s). |
|
Run a PipelineTask on a Quantum. |
lsst.pipe.base.connectionTypes Module¶
Classes¶
|
|
|
|
|
Class used for declaring PipelineTask input connections |
|
Class used for declaring PipelineTask prerequisite connections |
|
|
|
Base class used for declaring PipelineTask connections |
Class Inheritance Diagram¶
lsst.pipe.base.pipelineIR Module¶
Classes¶
|
Intermediate representation of configurations read from a pipeline yaml file. |
An exception that is raised when a pipeline contract is not satisfied |
|
|
Intermediate representation of configuration contracts read from a pipeline yaml file. |
|
An intermediate representation of imported pipelines |
|
Intermediate representation of a pipeline definition |
|
Intermediate representation of tasks read from a pipeline yaml file. |
|
Intermediate representation of named subset of task labels read from a pipeline yaml file. |