ImportIR¶
- class lsst.pipe.base.pipelineIR.ImportIR(location: str, include: list[str] | None = None, exclude: list[str] | None = None, importContracts: bool = True, importSteps: bool = True, labeledSubsetModifyMode: ~lsst.pipe.base.pipelineIR.PipelineSubsetCtrl = PipelineSubsetCtrl.DROP, instrument: ~typing.Literal[<_Tags.KeepInstrument: 1>] | str | None = _Tags.KeepInstrument)¶
Bases:
object
An intermediate representation of imported pipelines.
Attributes Summary
list of tasks that should be excluded when inheriting this pipeline.
Boolean attribute to dictate if contracts should be inherited with the pipeline or not.
Boolean attribute to dictate if steps should be inherited with the pipeline or not.
list of tasks that should be included when inheriting this pipeline.
Instrument to assign to the Pipeline at import.
Controls how labeled subsets are handled when an import ends up not including (either through an include or exclusion list) a task label that is defined in the
Pipeline
being imported.Methods Summary
Load in the Pipeline specified by this object, and turn it into a PipelineIR instance.
Attributes Documentation
- exclude: list[str] | None = 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: bool = True¶
Boolean attribute to dictate if contracts should be inherited with the pipeline or not.
- importSteps: bool = True¶
Boolean attribute to dictate if steps should be inherited with the pipeline or not.
- include: list[str] | None = 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: KeepInstrument: 1>] | str | None = 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.
- labeledSubsetModifyMode: PipelineSubsetCtrl = 1¶
Controls how labeled subsets are handled when an import ends up not including (either through an include or exclusion list) a task label that is defined in the
Pipeline
being imported. DROP will remove any subsets which contain a missing label. EDIT will change any subsets to not include the missing label.
Methods Documentation
- toPipelineIR() 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.
- pipeline