lsst.pipe.base  19.0.0-19-geb45990
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.base.config.PipelineTaskConfig Class Reference
Inheritance diagram for lsst.pipe.base.config.PipelineTaskConfig:
lsst.pipe.base.config.PipelineTaskConfigMeta

Public Member Functions

def __new__ (cls, name, bases, dct, **kwargs)
 

Static Public Attributes

 saveMetadata
 

Detailed Description

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
`~lsst.pex.config.ConfigField` with the attribute name `connections`.

Definition at line 113 of file config.py.

Member Function Documentation

◆ __new__()

def lsst.pipe.base.config.PipelineTaskConfigMeta.__new__ (   cls,
  name,
  bases,
  dct,
**  kwargs 
)
inherited

Definition at line 60 of file config.py.

Member Data Documentation

◆ saveMetadata

lsst.pipe.base.config.PipelineTaskConfig.saveMetadata
static
Initial value:
= pexConfig.Field(
dtype=bool, default=True, optional=False,
doc="Flag to enable/disable metadata saving for a task, enabled by default.")

Definition at line 126 of file config.py.


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