ParametersIR

class lsst.pipe.base.pipelineIR.ParametersIR(mapping: MutableMapping[str, Any])

Bases: object

Intermediate representation of parameters that are global to a pipeline.

Attributes

mappingdict [str, str]

A mutable mapping of identifiers as keys, and shared configuration as values.

Notes

These parameters are specified under a top level key named parameters and are declared as a yaml mapping. These entries can then be used inside task configuration blocks to specify configuration values. They may not be used in the special file or python blocks.

Examples

​parameters:
    shared_value: 14
    tasks:
        taskA:
            class: modA
            config:
                field1: parameters.shared_value
        taskB:
            class: modB
            config:
                field2: parameters.shared_value

Attributes Summary

mapping

A mutable mapping of identifiers as keys, and shared configuration as values.

Methods Summary

to_primitives()	Convert to a representation used in yaml serialization.
update(other)

Attributes Documentation

mapping: MutableMapping[str, Any] = <dataclasses._MISSING_TYPE object>

A mutable mapping of identifiers as keys, and shared configuration as values.

Methods Documentation

to_primitives() → MutableMapping[str, str]

Convert to a representation used in yaml serialization.

update(other: ParametersIR | None) → None