lsst.pipe.base  20.0.0-2-g04cfba9+2
Public Member Functions | Public Attributes | List of all members
lsst.pipe.base.pipeline.TaskDef Class Reference

Public Member Functions

def __init__ (self, taskName, config, taskClass=None, label="")
 
def configDatasetName (self)
 
def metadataDatasetName (self)
 
def __str__ (self)
 

Public Attributes

 taskName
 
 config
 
 taskClass
 
 label
 
 connections
 

Detailed Description

TaskDef is a collection of information about task needed by Pipeline.

The information includes task name, configuration object and optional
task class. This class is just a collection of attributes and it exposes
all of them so that attributes could potentially be modified in place
(e.g. if configuration needs extra overrides).

Attributes
----------
taskName : `str`
    `PipelineTask` class name, currently it is not specified whether this
    is a fully-qualified name or partial name (e.g. ``module.TaskClass``).
    Framework should be prepared to handle all cases.
config : `lsst.pex.config.Config`
    Instance of the configuration class corresponding to this task class,
    usually with all overrides applied.
taskClass : `type` or ``None``
    `PipelineTask` class object, can be ``None``. If ``None`` then
    framework will have to locate and load class.
label : `str`, optional
    Task label, usually a short string unique in a pipeline.

Definition at line 60 of file pipeline.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.base.pipeline.TaskDef.__init__ (   self,
  taskName,
  config,
  taskClass = None,
  label = "" 
)

Definition at line 83 of file pipeline.py.

Member Function Documentation

◆ __str__()

def lsst.pipe.base.pipeline.TaskDef.__str__ (   self)

Definition at line 106 of file pipeline.py.

◆ configDatasetName()

def lsst.pipe.base.pipeline.TaskDef.configDatasetName (   self)
Name of a dataset type for configuration of this task (`str`)

Definition at line 91 of file pipeline.py.

◆ metadataDatasetName()

def lsst.pipe.base.pipeline.TaskDef.metadataDatasetName (   self)
Name of a dataset type for metadata of this task, `None` if
metadata is not to be saved (`str`)

Definition at line 97 of file pipeline.py.

Member Data Documentation

◆ config

lsst.pipe.base.pipeline.TaskDef.config

Definition at line 85 of file pipeline.py.

◆ connections

lsst.pipe.base.pipeline.TaskDef.connections

Definition at line 88 of file pipeline.py.

◆ label

lsst.pipe.base.pipeline.TaskDef.label

Definition at line 87 of file pipeline.py.

◆ taskClass

lsst.pipe.base.pipeline.TaskDef.taskClass

Definition at line 86 of file pipeline.py.

◆ taskName

lsst.pipe.base.pipeline.TaskDef.taskName

Definition at line 84 of file pipeline.py.


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