ImportIR

class lsst.pipe.base.pipelineIR.ImportIR(location: str, include: Optional[List[str], None] = None, exclude: Optional[List[str], None] = None, importContracts: bool = True, instrument: Union[Literal[<_Tags.KeepInstrument: 1>], str, None] = <_Tags.KeepInstrument: 1>)

Bases: object

An intermediate representation of imported pipelines

Attributes Summary

exclude List of tasks that should be excluded when inheriting this pipeline.
importContracts Boolean attribute to dictate if contracts should be inherited with the pipeline or not.
include List of tasks that should be included when inheriting this pipeline.
instrument Instrument to assign to the Pipeline at import.

Methods Summary

toPipelineIR() Load in the Pipeline specified by this object, and turn it into a PipelineIR instance.

Attributes Documentation

exclude = None

List of tasks that should be excluded when inheriting this pipeline. Either the include or exclude attributes may be specified, but not both.

importContracts = True

Boolean attribute to dictate if contracts should be inherited with the pipeline or not.

include = None

List of tasks that should be included when inheriting this pipeline. Either the include or exclude attributes may be specified, but not both.

instrument = 1

Instrument to assign to the Pipeline at import. The default value of _Tags.KeepInstrument` indicates that whatever instrument the pipeline is declared with will not be modified. Setting this value to None will drop any declared instrument prior to import.

Methods Documentation

toPipelineIR() → lsst.pipe.base.pipelineIR.PipelineIR

Load in the Pipeline specified by this object, and turn it into a PipelineIR instance.

Returns:
pipeline : PipelineIR

A pipeline generated from the imported pipeline file