TaskDef¶

class lsst.pipe.base.TaskDef(taskName: str | None = None, config: PipelineTaskConfig | None = None, taskClass: type[lsst.pipe.base.pipelineTask.PipelineTask] | None = None, label: str | None = None, connections: PipelineTaskConnections | None = 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:

taskNamestr, optional: The fully-qualified PipelineTask class name. If not provided, taskClass must be.
configlsst.pipe.base.config.PipelineTaskConfig, 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.
taskClasstype, 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.
labelstr, optional: Task label, usually a short string unique in a pipeline. If not provided, taskClass must be, and taskClass._DefaultName will be used.
connectionsPipelineTaskConnections, optional: Object that describes the dataset types used by the task. If not provided, one will be constructed from the given configuration. If provided, it is assumed that config has already been validated and frozen.

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 (`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 (str)

Methods Documentation

classmethod makeMetadataDatasetName(label: str) → str¶

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

Parameters:

labelstr: Label for the task within its pipeline.

Returns:

namestr: Name of the task’s metadata dataset type.

Navigation

TaskDef¶