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 166 of file pipelineIR.py.

Member Function Documentation

__bool__()

bool lsst.pipe.base.pipelineIR.ParametersIR.__bool__

(

self

)

Definition at line 206 of file pipelineIR.py.

    def __bool__(self) -> bool:
        return bool(self.mapping)
 
 
@dataclass

__contains__()

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

Definition at line 200 of file pipelineIR.py.

    def __contains__(self, value: str) -> bool:
        return value in self.mapping
 

__getitem__()

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

Definition at line 203 of file pipelineIR.py.

    def __getitem__(self, item: str) -> Any:
        return self.mapping[item]
 

to_primitives()

MutableMapping[str, str] lsst.pipe.base.pipelineIR.ParametersIR.to_primitives

(

self

)

Convert to a representation used in yaml serialization

Definition at line 195 of file pipelineIR.py.

    def to_primitives(self) -> MutableMapping[str, str]:
        """Convert to a representation used in yaml serialization
        """
        return self.mapping
 

update()

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

Definition at line 191 of file pipelineIR.py.

    def update(self, other: Optional[ParametersIR]):
        if other is not None:
            self.mapping.update(other.mapping)
 

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.4.3/Linux64/pipe_base/22.0.1+94e66cc9ed/python/lsst/pipe/base/pipelineIR.py