lsst.pipe.base.taskFactory.TaskFactory Class Reference

Inheritance diagram for lsst.pipe.base.taskFactory.TaskFactory:

Public Member Functions
def	makeTask (self, taskClass, config, overrides, butler)

Detailed Description

Abstract base class for task factory.

Task factory is responsible for creating instances of PipelineTask
subclasses.

Definition at line 30 of file taskFactory.py.

Member Function Documentation

makeTask()

def lsst.pipe.base.taskFactory.TaskFactory.makeTask	(		self,
			taskClass,
			config,
			overrides,
			butler
	)

Create new PipelineTask instance from its class.

Parameters
----------
taskClass : `type`
    `PipelineTask` sub-class.
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 : `~lsst.daf.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.

Definition at line 38 of file taskFactory.py.

---

The documentation for this class was generated from the following file:

• python/lsst/pipe/base/taskFactory.py