lsst.pipe.base  21.0.0-8-gfbe0b4b+c10f409f79
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.base.pipelineIR.ConfigIR Class Reference

Public Member Functions

dict to_primitives (self)
 
ConfigIR formatted (self, ParametersIR parameters)
 
Generator["ConfigIR", None, None] maybe_merge (self, "ConfigIR" other_config)
 
def __eq__ (self, "ConfigIR" other)
 

Public Attributes

 file
 

Static Public Attributes

 default_factory
 
 dict
 

Detailed Description

Intermediate representation of configurations read from a pipeline yaml
file.

Definition at line 208 of file pipelineIR.py.

Member Function Documentation

◆ __eq__()

def lsst.pipe.base.pipelineIR.ConfigIR.__eq__ (   self,
"ConfigIR"  other 
)

Definition at line 313 of file pipelineIR.py.

◆ formatted()

ConfigIR lsst.pipe.base.pipelineIR.ConfigIR.formatted (   self,
ParametersIR  parameters 
)
Returns a new ConfigIR object that is formatted according to the
specified parameters

Parameters
----------
parameters : ParametersIR
    Object that contains variable mappings used in substitution.

Returns
-------
config : ConfigIR
    A new ConfigIR object formatted with the input parameters

Definition at line 247 of file pipelineIR.py.

◆ maybe_merge()

Generator["ConfigIR", None, None] lsst.pipe.base.pipelineIR.ConfigIR.maybe_merge (   self,
"ConfigIR"  other_config 
)
Merges another instance of a `ConfigIR` into this instance if
possible. This function returns a generator that is either self
if the configs were merged, or self, and other_config if that could
not be merged.

Parameters
----------
other_config : `ConfigIR`
    An instance of `ConfigIR` to merge into this instance.

Returns
-------
Generator : `ConfigIR`
    A generator containing either self, or self and other_config if
    the configs could be merged or not respectively.

Definition at line 274 of file pipelineIR.py.

◆ to_primitives()

dict lsst.pipe.base.pipelineIR.ConfigIR.to_primitives (   self)
Convert to a representation used in yaml serialization

Definition at line 233 of file pipelineIR.py.

Member Data Documentation

◆ default_factory

lsst.pipe.base.pipelineIR.ConfigIR.default_factory
static

Definition at line 222 of file pipelineIR.py.

◆ dict

lsst.pipe.base.pipelineIR.ConfigIR.dict
static

Definition at line 227 of file pipelineIR.py.

◆ file

lsst.pipe.base.pipelineIR.ConfigIR.file

Definition at line 309 of file pipelineIR.py.


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