TaskFactory

class lsst.pipe.base.TaskFactory

Bases: object

Abstract base class for task factory.

Task factory is responsible for creating instances of PipelineTask subclasses.

Methods Summary

makeTask(taskClass, name, config, overrides, …)

Create new PipelineTask instance from its class.

Methods Documentation

makeTask(taskClass: Type[PipelineTask], name: Optional[str], config: Optional[PipelineTaskConfig], overrides: Optional[ConfigOverrides], butler: Optional[Butler]) → PipelineTask

Create new PipelineTask instance from its class.

Parameters:

taskClass : type

PipelineTask sub-class.

name : str or None

The name of the new task; if None then use taskClass._DefaultName.

config : pex.Config or None

Configuration object, if None then use task-defined configuration class (taskClass.ConfigClass) to create new instance.

overrides : ConfigOverrides or None

Configuration overrides, this should contain all overrides to be applied to a default task config, including instrument-specific, obs-package specific, and possibly command-line overrides. This parameter is exclusive with config, only one of the two can be specified as not-None.

butler : Butler or None

Butler instance used to obtain initialization inputs for PipelineTasks. If None, some PipelineTasks will not be usable

Returns:

task : PipelineTask

Instance of a PipelineTask class or None on errors.

Raises:

Any exceptions that are raised by PipelineTask constructor or its

configuration class are propagated back to caller.