ButlerQuantumContext¶
- class lsst.pipe.base.ButlerQuantumContext(*, limited: LimitedButler, quantum: Quantum, butler: Butler | None = None)¶
Bases:
object
A 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.
Do not use constructor directly, instead use
from_full
orfrom_limited
factory methods.Notes
ButlerQuantumContext
instances are backed by eitherlsst.daf.butler.Butler
orlsst.daf.butler.LimitedButler
. When a limited butler is used then quantum has to contain dataset references that are completely resolved (usually when graph is constructed by GraphBuilder).When instances are backed by full butler, the quantum graph does not have to resolve output or intermediate references, but input references of each quantum have to be resolved before they can be used by this class. When executing such graphs, intermediate references used as input to some Quantum are resolved by
lsst.ctrl.mpexec.SingleQuantumExecutor
. If output references of a quanta are resolved, they will be unresolved when full butler is used.Attributes Summary
Structure managing all dimensions recognized by this data repository (
DimensionUniverse
).Methods Summary
from_full
(butler, quantum)Make ButlerQuantumContext backed by
lsst.daf.butler.Butler
.from_limited
(butler, quantum)Make ButlerQuantumContext backed by
lsst.daf.butler.LimitedButler
.get
(dataset)Fetches data from the butler
put
(values, dataset)Puts data into the butler
Attributes Documentation
- dimensions¶
Structure managing all dimensions recognized by this data repository (
DimensionUniverse
).
Methods Documentation
- classmethod from_full(butler: Butler, quantum: Quantum) ButlerQuantumContext ¶
Make ButlerQuantumContext backed by
lsst.daf.butler.Butler
.- 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. All input dataset references must be resolved in this Quantum. Output references can be resolved, but they will be unresolved.
- butler
- Returns:
- butlerQC
ButlerQuantumContext
Instance of butler wrapper.
- butlerQC
- classmethod from_limited(butler: LimitedButler, quantum: Quantum) ButlerQuantumContext ¶
Make ButlerQuantumContext backed by
lsst.daf.butler.LimitedButler
.- Parameters:
- butler
lsst.daf.butler.LimitedButler
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. Both input and output dataset references must be resolved in this Quantum.
- butler
- Returns:
- butlerQC
ButlerQuantumContext
Instance of butler wrapper.
- butlerQC
- get(dataset: InputQuantizedConnection | List[DatasetRef | None] | List[DeferredDatasetRef | None] | DatasetRef | DeferredDatasetRef | None) Any ¶
Fetches data from the butler
- Parameters:
- dataset
This argument may either be an
InputQuantizedConnection
which describes all the inputs of a quantum, a list ofDatasetRef
, or a singleDatasetRef
. The function will get and return the corresponding datasets from the butler. IfNone
is passed in place of aDatasetRef
then the corresponding returned object will beNone
.
- Returns:
- return
object
This function returns arbitrary objects fetched from the bulter. The structure these objects are returned in depends on the type of the input argument. If the input dataset argument is a
InputQuantizedConnection
, then the return type will be a dictionary with keys corresponding to the attributes of theInputQuantizedConnection
(which in turn are the attribute identifiers of the connections). If the input argument is of typelist
ofDatasetRef
then the return type will be a list of objects. If the input argument is a singleDatasetRef
then a single object will be returned.
- return
- Raises:
- ValueError
Raised if a
DatasetRef
is passed to get that is not defined in the quantum object
- put(values: Struct | List[Any] | Any, dataset: OutputQuantizedConnection | List[DatasetRef] | DatasetRef) None ¶
Puts data into the butler
- Parameters:
- values
Struct
orlist
ofobject
orobject
The data that should be put with the butler. If the type of the dataset is
OutputQuantizedConnection
then this argument should be aStruct
with corresponding attribute names. Each attribute should then correspond to either a list of object or a single object depending of the type of the corresponding attribute on dataset. I.e. ifdataset.calexp
is[datasetRef1, datasetRef2]
thenvalues.calexp
should be[calexp1, calexp2]
. Like wise if there is a single ref, then only a single object need be passed. The same restriction applies if dataset is directly alist
ofDatasetRef
or a singleDatasetRef
.- dataset
This argument may either be an
InputQuantizedConnection
which describes all the inputs of a quantum, a list oflsst.daf.butler.DatasetRef
, or a singlelsst.daf.butler.DatasetRef
. The function will get and return the corresponding datasets from the butler.
- values
- Raises:
- ValueError
Raised if a
DatasetRef
is passed to put that is not defined in the quantum object, or the type of values does not match what is expected from the type of dataset.