LSST Applications  22.0.1,22.0.1+01bcf6a671,22.0.1+046ee49490,22.0.1+05c7de27da,22.0.1+0c6914dbf6,22.0.1+1220d50b50,22.0.1+12fd109e95,22.0.1+1a1dd69893,22.0.1+1c910dc348,22.0.1+1ef34551f5,22.0.1+30170c3d08,22.0.1+39153823fd,22.0.1+611137eacc,22.0.1+771eb1e3e8,22.0.1+94e66cc9ed,22.0.1+9a075d06e2,22.0.1+a5ff6e246e,22.0.1+a7db719c1a,22.0.1+ba0d97e778,22.0.1+bfe1ee9056,22.0.1+c4e1e0358a,22.0.1+cc34b8281e,22.0.1+d640e2c0fa,22.0.1+d72a2e677a,22.0.1+d9a6b571bd,22.0.1+e485e9761b,22.0.1+ebe8d3385e
LSST Data Management Base Package
Public Member Functions | List of all members
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.

38  def makeTask(self, taskClass, config, overrides, butler):
39  """Create new PipelineTask instance from its class.
40 
41  Parameters
42  ----------
43  taskClass : `type`
44  `PipelineTask` sub-class.
45  config : `pex.Config` or `None`
46  Configuration object, if `None` then use task-defined
47  configuration class (``taskClass.ConfigClass``) to create new
48  instance.
49  overrides : `ConfigOverrides` or `None`
50  Configuration overrides, this should contain all overrides to be
51  applied to a default task config, including instrument-specific,
52  obs-package specific, and possibly command-line overrides. This
53  parameter is exclusive with ``config``, only one of the two can be
54  specified as not-`None`.
55  butler : `~lsst.daf.butler.Butler` or None
56  Butler instance used to obtain initialization inputs for
57  PipelineTasks. If `None`, some PipelineTasks will not be usable
58 
59  Returns
60  -------
61  task : `PipelineTask`
62  Instance of a `PipelineTask` class or `None` on errors.
63 
64  Raises
65  ------
66  Any exceptions that are raised by PipelineTask constructor or its
67  configuration class are propagated back to caller.
68  """

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