lsst.pipe.base  19.0.0-3-g3c38ad5
Public Member Functions | Public Attributes | List of all members
lsst.pipe.base.butlerQuantumContext.ButlerQuantumContext Class Reference

Public Member Functions

def __init__
 
def get
 
def put
 

Public Attributes

 quantum
 
 registry
 
 allInputs
 
 allOutputs
 

Detailed Description

Butler like class specialized for a single quantum

A ButlerQuantumContext class wraps a standard butler interface and
specializes it to the context of a given quantum. What this means
in practice is that the only gets and puts that this class allows
are DatasetRefs that are contained in the quantum.

In the future this class will also be used to record provenance on
what was actually get and put. This is in contrast to what the
preflight expects to be get and put by looking at the graph before
execution.

Parameters
----------
butler : `lsst.daf.butler.Butler`
    Butler object from/to which datasets will be get/put
quantum : `lsst.daf.butler.core.Quantum`
    Quantum object that describes the datasets which will
    be get/put by a single execution of this node in the
    pipeline graph.

Definition at line 35 of file butlerQuantumContext.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.base.butlerQuantumContext.ButlerQuantumContext.__init__ (   self,
  butler 
)

Definition at line 57 of file butlerQuantumContext.py.

Member Function Documentation

◆ get()

def lsst.pipe.base.butlerQuantumContext.ButlerQuantumContext.get (   self,
  dataset 
)

Definition at line 87 of file butlerQuantumContext.py.

◆ put()

def lsst.pipe.base.butlerQuantumContext.ButlerQuantumContext.put (   self,
  values 
)

Definition at line 135 of file butlerQuantumContext.py.

Member Data Documentation

◆ allInputs

lsst.pipe.base.butlerQuantumContext.ButlerQuantumContext.allInputs

Definition at line 60 of file butlerQuantumContext.py.

◆ allOutputs

lsst.pipe.base.butlerQuantumContext.ButlerQuantumContext.allOutputs

Definition at line 61 of file butlerQuantumContext.py.

◆ quantum

lsst.pipe.base.butlerQuantumContext.ButlerQuantumContext.quantum

Definition at line 58 of file butlerQuantumContext.py.

◆ registry

lsst.pipe.base.butlerQuantumContext.ButlerQuantumContext.registry

Definition at line 59 of file butlerQuantumContext.py.


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