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).
- Parameters:
- taskName
str
, optional The fully-qualified
PipelineTask
class name. If not provided,taskClass
must be.- config
lsst.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 andtaskClass.ConfigClass()
will be used.- taskClass
type
, optional PipelineTask
class object; if provided andtaskName
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, andtaskClass._DefaultName
will be used.- connections
PipelineTaskConnections
, 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.
- taskName
Attributes Summary
Name of a dataset type for configuration of this task (
str
).Name of a dataset type for log output from this task,
None
if logs are not to be saved (str
).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
- logOutputDatasetName¶
Name of a dataset type for log output from this task,
None
if logs are not to be saved (str
).
Methods Documentation