|
lsst.pipe.base
18.1.0-2-g0ee56d7
|
Public Member Functions | |
| def | __init__ (self, taskFactory, pipeline=None) |
| def | pipeline (self, ordered=False) |
| def | addTask (self, taskName, label=None) |
| def | deleteTask (self, label) |
| def | moveTask (self, label, newIndex) |
| def | labelTask (self, label, newLabel) |
| def | configOverride (self, label, value) |
| def | configOverrideFile (self, label, path) |
| def | substituteDatatypeNames (self, label, value) |
PipelineBuilder class is responsible for building task pipeline.
The class provides a set of methods to manipulate pipeline by adding,
deleting, re-ordering tasks in pipeline and changing their labels or
configuration.
Parameters
----------
taskFactory : `TaskFactory`
Factory object used to load/instantiate PipelineTasks
pipeline : `Pipeline`, optional
Initial pipeline to be modified, if `None` then new empty pipeline
will be created.
Definition at line 50 of file pipelineBuilder.py.
| def lsst.pipe.base.pipelineBuilder.PipelineBuilder.__init__ | ( | self, | |
| taskFactory, | |||
pipeline = None |
|||
| ) |
Definition at line 65 of file pipelineBuilder.py.
| def lsst.pipe.base.pipelineBuilder.PipelineBuilder.addTask | ( | self, | |
| taskName, | |||
label = None |
|||
| ) |
Append new task to a pipeline.
Parameters
----------
taskName : `str`
Name of the new task, can be either full class name including
package and module, or just a class name to be searched in
known packages and modules.
label : `str`, optional
Label for new task, if `None` then task class name is used as
label.
Definition at line 101 of file pipelineBuilder.py.
| def lsst.pipe.base.pipelineBuilder.PipelineBuilder.configOverride | ( | self, | |
| label, | |||
| value | |||
| ) |
Apply single config override.
Parameters
----------
label : `str`
Label of the task.
value : `str`
String in the form ``"param=value"`` or ``"parm.subpar=value"``,
``value`` can be a Python constant or a list of constants.
Definition at line 175 of file pipelineBuilder.py.
| def lsst.pipe.base.pipelineBuilder.PipelineBuilder.configOverrideFile | ( | self, | |
| label, | |||
| path | |||
| ) |
Apply overrides from file.
Parameters
----------
label : `str`
Label of the task.
path : `str`
Path to file with overrides.
Definition at line 194 of file pipelineBuilder.py.
| def lsst.pipe.base.pipelineBuilder.PipelineBuilder.deleteTask | ( | self, | |
| label | |||
| ) |
Remove task from a pipeline.
Parameters
----------
label : `str`
Label of the task to remove.
Definition at line 129 of file pipelineBuilder.py.
| def lsst.pipe.base.pipelineBuilder.PipelineBuilder.labelTask | ( | self, | |
| label, | |||
| newLabel | |||
| ) |
Change task label.
Parameters
----------
label : `str`
Existing label of the task.
newLabel : `str`
New label of the task.
Definition at line 157 of file pipelineBuilder.py.
| def lsst.pipe.base.pipelineBuilder.PipelineBuilder.moveTask | ( | self, | |
| label, | |||
| newIndex | |||
| ) |
Move task to a new position in a pipeline.
Parameters
----------
label : `str`
Label of the task to move.
newIndex : `int`
New position.
Definition at line 142 of file pipelineBuilder.py.
| def lsst.pipe.base.pipelineBuilder.PipelineBuilder.pipeline | ( | self, | |
ordered = False |
|||
| ) |
Return updated pipeline instance.
Pipeline will be checked for possible inconsistencies before
returning.
Parameters
----------
ordered : `bool`, optional
If `True` then order resulting pipeline according to Task data
dependencies.
Returns
-------
pipeline : `Pipeline`
Raises
------
Exception
Raised if any inconsistencies are detected in pipeline definition,
see `pipeTools.orderPipeline` for list of exception types.
Definition at line 71 of file pipelineBuilder.py.
| def lsst.pipe.base.pipelineBuilder.PipelineBuilder.substituteDatatypeNames | ( | self, | |
| label, | |||
| value | |||
| ) |
Apply name string formatting to config file.
Parameters
----------
label : `str`
Label of the task.
value : `dict`
A python dict used in formatting nameTemplates.
Definition at line 211 of file pipelineBuilder.py.
1.8.13