lsst.pipe.base.pipelineIR.InheritIR Class Reference

Public Member Functions
"PipelineIR"	toPipelineIR (self, instrument=None)
def	__eq__ (self, "InheritIR" other)

Static Public Attributes
	bool

Detailed Description

An intermediate representation of inherited pipelines

Definition at line 373 of file pipelineIR.py.

Member Function Documentation

__eq__()

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

Definition at line 444 of file pipelineIR.py.

    def __eq__(self, other: "InheritIR"):
        if not isinstance(other, InheritIR):
            return False
        elif all(getattr(self, attr) == getattr(other, attr) for attr in
                 ("location", "include", "exclude", "importContracts")):
            return True
        else:
            return False
 
 

toPipelineIR()

"PipelineIR" lsst.pipe.base.pipelineIR.InheritIR.toPipelineIR	(		self,
			instrument = None
	)

Load in the Pipeline specified by this object, and turn it into a
PipelineIR instance.

Parameters
----------
instrument : Optional `str`
    A string giving the fully qualified path to an instrument object.
    If a inherited pipeline defines the same instrument as defined in
    this variable, an import warning message is skipped.

Returns
-------
pipeline : `PipelineIR`
    A pipeline generated from the imported pipeline file

Definition at line 395 of file pipelineIR.py.

    def toPipelineIR(self, instrument=None) -> "PipelineIR":
        """Load in the Pipeline specified by this object, and turn it into a
        PipelineIR instance.
 
        Parameters
        ----------
        instrument : Optional `str`
            A string giving the fully qualified path to an instrument object.
            If a inherited pipeline defines the same instrument as defined in
            this variable, an import warning message is skipped.
 
        Returns
        -------
        pipeline : `PipelineIR`
            A pipeline generated from the imported pipeline file
        """
        if self.include and self.exclude:
            raise ValueError("Both an include and an exclude list cant be specified"
                             " when declaring a pipeline import")
        tmp_pipeline = PipelineIR.from_file(os.path.expandvars(self.location))
        if tmp_pipeline.instrument is not None and tmp_pipeline.instrument != instrument:
            warnings.warn("Any instrument definitions in imported pipelines are ignored. "
                          "if an instrument is desired please define it in the top most pipeline")
 
        included_labels = set()
        for label in tmp_pipeline.tasks:
            if (self.include and label in self.include) or (self.exclude and label not in self.exclude)\
                    or (self.include is None and self.exclude is None):
                included_labels.add(label)
 
        # Handle labeled subsets being specified in the include or exclude
        # list, adding or removing labels.
        if self.include is not None:
            subsets_in_include = tmp_pipeline.labeled_subsets.keys() & self.include
            for label in subsets_in_include:
                included_labels.update(tmp_pipeline.labeled_subsets[label].subset)
 
        elif self.exclude is not None:
            subsets_in_exclude = tmp_pipeline.labeled_subsets.keys() & self.exclude
            for label in subsets_in_exclude:
                included_labels.difference_update(tmp_pipeline.labeled_subsets[label].subset)
 
        tmp_pipeline = tmp_pipeline.subset_from_labels(included_labels)
 
        if not self.importContracts:
            tmp_pipeline.contracts = []
 
        return tmp_pipeline
 

Member Data Documentation

bool

lsst.pipe.base.pipelineIR.InheritIR.bool

static

Definition at line 390 of file pipelineIR.py.

---

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

• /j/snowflake/release/lsstsw/stack/cb4e2dc/Linux64/pipe_base/21.0.0-4-g051ac7e+1e83416353/python/lsst/pipe/base/pipelineIR.py