PipelineTaskConfig

class lsst.pipe.base.PipelineTaskConfig(*args, **kw)

Bases: Config

Configuration class for PipelineTask.

This Configuration class functions in largely the same manner as any other derived from lsst.pex.config.Config. The only difference is in how it is declared. PipelineTaskConfig children need to be declared with a pipelineConnections argument. This argument should specify a child class of PipelineTaskConnections. During the declaration of a PipelineTaskConfig a config class is created with information from the supplied connections class to allow configuration of the connections class. This dynamically created config class is then attached to the PipelineTaskConfig via a ConfigField with the attribute name connections.

Attributes Summary

saveLogOutput

Flag to enable/disable saving of log output for a task, enabled by default.

Methods Summary

applyConfigOverrides(instrument, ...)

Apply config overrides to this config instance.

Attributes Documentation

saveLogOutput

Flag to enable/disable saving of log output for a task, enabled by default. (bool, default True)

Methods Documentation

applyConfigOverrides(instrument: Instrument | None, taskDefaultName: str, pipelineConfigs: Iterable[ConfigIR] | None, parameters: ParametersIR, label: str) → None

Apply config overrides to this config instance.

Parameters

instrumentInstrument or None

An instance of the Instrument specified in a pipeline. If None then the pipeline did not specify and instrument.

taskDefaultNamestr

The default name associated with the Task class. This may be used with instrumental overrides.

pipelineConfigsIterable of ConfigIR

An iterable of ConfigIR objects that contain overrides to apply to this config instance.

parametersParametersIR

Parameters defined in a Pipeline which are used in formatting of config values across multiple Task in a pipeline.

labelstr

The label associated with this class’s Task in a pipeline.