TaskDef

class lsst.pipe.base.TaskDef(taskName: Optional[str] = None, config: Optional[Config] = None, taskClass: Optional[Type[PipelineTask]] = None, label: Optional[str] = None)

Bases: object

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, optional

The fully-qualified PipelineTask class name. If not provided, taskClass must be.

config : lsst.pex.config.Config, optional

Instance of the configuration class corresponding to this task class, usually with all overrides applied. This config will be frozen. If not provided, taskClass must be provided and taskClass.ConfigClass() will be used.

taskClass : type, optional

PipelineTask class object; if provided and taskName is as well, the caller guarantees that they are consistent. If not provided, taskName is used to import the type.

label : str, optional

Task label, usually a short string unique in a pipeline. If not provided, taskClass must be, and taskClass._DefaultName will be used.

Attributes Summary

configDatasetName	Name of a dataset type for configuration of this task (str)
logOutputDatasetName	Name of a dataset type for log output from this task, None if logs are not to be saved (str)
metadataDatasetName	Name of a dataset type for metadata of this task, None if metadata is not to be saved (str)

Methods Summary

makeMetadataDatasetName(label)

Construct the name of the dataset type for metadata for a task.

Attributes Documentation

configDatasetName

Name of a dataset type for configuration of this task (str)

logOutputDatasetName

Name of a dataset type for log output from this task, None if logs are not to be saved (str)

metadataDatasetName

Name of a dataset type for metadata of this task, None if metadata is not to be saved (str)

Methods Documentation

classmethod makeMetadataDatasetName(label: str) → str

Construct the name of the dataset type for metadata for a task.

Parameters:

label : str

Label for the task within its pipeline.

Returns:

name : str

Name of the task’s metadata dataset type.