lsst.pipe.base  20.0.0-25-g3dcad98+4c648bd8fe
Public Member Functions | Public Attributes | List of all members
lsst.pipe.base.pipelineIR.PipelineIR Class Reference

Public Member Functions

def __init__ (self, loaded_yaml)
 
PipelineIR subset_from_labels (self, Set[str] labelSpecifier)
 
def from_string (cls, str pipeline_string)
 
def from_file (cls, str filename)
 
def to_file (self, str filename)
 
def to_primitives (self)
 
str __str__ (self)
 
str __repr__ (self)
 
def __eq__ (self, "PipelineIR" other)
 

Public Attributes

 description
 
 instrument
 
 contracts
 
 labeled_subsets
 
 inherits
 
 tasks
 

Detailed Description

Intermediate representation of a pipeline definition

Parameters
----------
loaded_yaml : `dict`
    A dictionary which matches the structure that would be produced by a
    yaml reader which parses a pipeline definition document

Raises
------
ValueError :
    - If a pipeline is declared without a description
    - If no tasks are declared in a pipeline, and no pipelines are to be
      inherited
    - If more than one instrument is specified
    - If more than one inherited pipeline share a label

Definition at line 369 of file pipelineIR.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.base.pipelineIR.PipelineIR.__init__ (   self,
  loaded_yaml 
)

Definition at line 387 of file pipelineIR.py.

Member Function Documentation

◆ __eq__()

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

Definition at line 718 of file pipelineIR.py.

◆ __repr__()

str lsst.pipe.base.pipelineIR.PipelineIR.__repr__ (   self)
Instance formatting as how it would look in yaml representation

Definition at line 713 of file pipelineIR.py.

◆ __str__()

str lsst.pipe.base.pipelineIR.PipelineIR.__str__ (   self)
Instance formatting as how it would look in yaml representation

Definition at line 708 of file pipelineIR.py.

◆ from_file()

def lsst.pipe.base.pipelineIR.PipelineIR.from_file (   cls,
str  filename 
)
Create a `PipelineIR` object from the document specified by the
input path.

Parameters
----------
filename : `str`
    Location of document to use in creating a `PipelineIR` object.

Definition at line 670 of file pipelineIR.py.

◆ from_string()

def lsst.pipe.base.pipelineIR.PipelineIR.from_string (   cls,
str  pipeline_string 
)
Create a `PipelineIR` object from a string formatted like a pipeline
document

Parameters
----------
pipeline_string : `str`
    A string that is formatted according like a pipeline document

Definition at line 657 of file pipelineIR.py.

◆ subset_from_labels()

PipelineIR lsst.pipe.base.pipelineIR.PipelineIR.subset_from_labels (   self,
Set[str]  labelSpecifier 
)
Subset a pipelineIR to contain only labels specified in
labelSpecifier.

Parameters
----------
labelSpecifier : `set` of `str`
    Set containing labels that describes how to subset a pipeline.

Returns
-------
pipeline : `PipelineIR`
    A new pipelineIR object that is a subset of the old pipelineIR

Raises
------
ValueError
    Raised if there is an issue with specified labels

Notes
-----
This method attempts to prune any contracts that contain labels which
are not in the declared subset of labels. This pruning is done using a
string based matching due to the nature of contracts and may prune more
than it should. Any labeled subsets defined that no longer have all
members of the subset present in the pipeline will be removed from the
resulting pipeline.

Definition at line 591 of file pipelineIR.py.

◆ to_file()

def lsst.pipe.base.pipelineIR.PipelineIR.to_file (   self,
str  filename 
)
Serialize this `PipelineIR` object into a yaml formatted string and
write the output to a file at the specified path.

Parameters
----------
filename : `str`
    Location of document to write a `PipelineIR` object.

Definition at line 683 of file pipelineIR.py.

◆ to_primitives()

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

Definition at line 695 of file pipelineIR.py.

Member Data Documentation

◆ contracts

lsst.pipe.base.pipelineIR.PipelineIR.contracts

Definition at line 432 of file pipelineIR.py.

◆ description

lsst.pipe.base.pipelineIR.PipelineIR.description

Definition at line 397 of file pipelineIR.py.

◆ inherits

lsst.pipe.base.pipelineIR.PipelineIR.inherits

Definition at line 490 of file pipelineIR.py.

◆ instrument

lsst.pipe.base.pipelineIR.PipelineIR.instrument

Definition at line 406 of file pipelineIR.py.

◆ labeled_subsets

lsst.pipe.base.pipelineIR.PipelineIR.labeled_subsets

Definition at line 449 of file pipelineIR.py.

◆ tasks

lsst.pipe.base.pipelineIR.PipelineIR.tasks

Definition at line 537 of file pipelineIR.py.


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