lsst.pipe.base  21.0.0-6-gd3283ba+55f5a6a5c9
Public Member Functions | Public Attributes | List of all members
lsst.pipe.base.graph._loadHelpers.FileLoadHelper Class Reference
Inheritance diagram for lsst.pipe.base.graph._loadHelpers.FileLoadHelper:
lsst.pipe.base.graph._loadHelpers.DefaultLoadHelper

Public Member Functions

def close (self)
 
QuantumGraph load (self, Optional[Iterable[int]] nodes=None, Optional[str] graphID=None)
 

Public Attributes

 fileHandle
 
 uriObject
 
 headerSize
 
 save_version
 
 taskDefMap
 
 map
 
 buffer
 

Detailed Description

Definition at line 299 of file _loadHelpers.py.

Member Function Documentation

◆ close()

def lsst.pipe.base.graph._loadHelpers.FileLoadHelper.close (   self)
Cleans up an instance if needed. Base class does nothing

Reimplemented from lsst.pipe.base.graph._loadHelpers.DefaultLoadHelper.

Definition at line 307 of file _loadHelpers.py.

◆ load()

QuantumGraph lsst.pipe.base.graph._loadHelpers.DefaultLoadHelper.load (   self,
Optional[Iterable[int]]   nodes = None,
Optional[str]   graphID = None 
)
inherited
Loads in the specified nodes from the graph

Load in the `QuantumGraph` containing only the nodes specified in the
``nodes`` parameter from the graph specified at object creation. If
``nodes`` is None (the default) the whole graph is loaded.

Parameters
----------
nodes : `Iterable` of `int` or `None`
    The nodes to load from the graph, loads all if value is None
    (the default)
graphID : `str` or `None`
    If specified this ID is verified against the loaded graph prior to
    loading any Nodes. This defaults to None in which case no
    validation is done.

Returns
-------
graph : `QuantumGraph`
    The loaded `QuantumGraph` object

Raises
------
ValueError
    Raised if one or more of the nodes requested is not in the
    `QuantumGraph` or if graphID parameter does not match the graph
    being loaded.

Definition at line 163 of file _loadHelpers.py.

Member Data Documentation

◆ buffer

lsst.pipe.base.graph._loadHelpers.DefaultLoadHelper.buffer
inherited

Definition at line 269 of file _loadHelpers.py.

◆ fileHandle

lsst.pipe.base.graph._loadHelpers.FileLoadHelper.fileHandle

Definition at line 303 of file _loadHelpers.py.

◆ headerSize

lsst.pipe.base.graph._loadHelpers.DefaultLoadHelper.headerSize
inherited

Definition at line 113 of file _loadHelpers.py.

◆ map

lsst.pipe.base.graph._loadHelpers.DefaultLoadHelper.map
inherited

Definition at line 161 of file _loadHelpers.py.

◆ save_version

lsst.pipe.base.graph._loadHelpers.DefaultLoadHelper.save_version
inherited

Definition at line 142 of file _loadHelpers.py.

◆ taskDefMap

lsst.pipe.base.graph._loadHelpers.DefaultLoadHelper.taskDefMap
inherited

Definition at line 154 of file _loadHelpers.py.

◆ uriObject

lsst.pipe.base.graph._loadHelpers.DefaultLoadHelper.uriObject
inherited

Definition at line 108 of file _loadHelpers.py.


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