lsst.pipe.base  21.0.0-8-gfbe0b4b+411cd868f8
Public Member Functions | List of all members
lsst.pipe.base.pipelineIR.ParametersIR Class Reference

Public Member Functions

def update (self, Optional[ParametersIR] other)
 
MutableMapping[str, str] to_primitives (self)
 
bool __contains__ (self, str value)
 
Any __getitem__ (self, str item)
 
bool __bool__ (self)
 

Detailed Description

Intermediate representation of parameters that are global to a pipeline

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.

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

Definition at line 163 of file pipelineIR.py.

Member Function Documentation

◆ __bool__()

bool lsst.pipe.base.pipelineIR.ParametersIR.__bool__ (   self)

Definition at line 203 of file pipelineIR.py.

◆ __contains__()

bool lsst.pipe.base.pipelineIR.ParametersIR.__contains__ (   self,
str  value 
)

Definition at line 197 of file pipelineIR.py.

◆ __getitem__()

Any lsst.pipe.base.pipelineIR.ParametersIR.__getitem__ (   self,
str  item 
)

Definition at line 200 of file pipelineIR.py.

◆ to_primitives()

MutableMapping[str, str] lsst.pipe.base.pipelineIR.ParametersIR.to_primitives (   self)
Convert to a representation used in yaml serialization

Definition at line 192 of file pipelineIR.py.

◆ update()

def lsst.pipe.base.pipelineIR.ParametersIR.update (   self,
Optional[ParametersIR other 
)

Definition at line 188 of file pipelineIR.py.


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