lsst.pipe.base  19.0.0-24-g878c510+7
Public Member Functions | Public Attributes | List of all members
lsst.pipe.base.pipelineIR.PipelineIR Class Reference

Public Member Functions

def __init__ (self, loaded_yaml)
 
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
 
 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 262 of file pipelineIR.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 280 of file pipelineIR.py.

Member Function Documentation

◆ __eq__()

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

Definition at line 458 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 453 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 448 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 412 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 399 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 425 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 437 of file pipelineIR.py.

Member Data Documentation

◆ contracts

lsst.pipe.base.pipelineIR.PipelineIR.contracts

Definition at line 317 of file pipelineIR.py.

◆ description

lsst.pipe.base.pipelineIR.PipelineIR.description

Definition at line 288 of file pipelineIR.py.

◆ inherits

lsst.pipe.base.pipelineIR.PipelineIR.inherits

Definition at line 344 of file pipelineIR.py.

◆ instrument

lsst.pipe.base.pipelineIR.PipelineIR.instrument

Definition at line 297 of file pipelineIR.py.

◆ tasks

lsst.pipe.base.pipelineIR.PipelineIR.tasks

Definition at line 360 of file pipelineIR.py.


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