lsst.pipe.base
20.0.0+2
|
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 | |
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.
def lsst.pipe.base.pipelineIR.PipelineIR.__init__ | ( | self, | |
loaded_yaml | |||
) |
Definition at line 280 of file pipelineIR.py.
def lsst.pipe.base.pipelineIR.PipelineIR.__eq__ | ( | self, | |
"PipelineIR" | other | ||
) |
Definition at line 458 of file pipelineIR.py.
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 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.
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.
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.
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.
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.
lsst.pipe.base.pipelineIR.PipelineIR.contracts |
Definition at line 317 of file pipelineIR.py.
lsst.pipe.base.pipelineIR.PipelineIR.description |
Definition at line 288 of file pipelineIR.py.
lsst.pipe.base.pipelineIR.PipelineIR.inherits |
Definition at line 344 of file pipelineIR.py.
lsst.pipe.base.pipelineIR.PipelineIR.instrument |
Definition at line 297 of file pipelineIR.py.
lsst.pipe.base.pipelineIR.PipelineIR.tasks |
Definition at line 360 of file pipelineIR.py.