InMemoryDatasetHandle¶
- class lsst.pipe.base.InMemoryDatasetHandle(inMemoryDataset: ~typing.Any, storageClass: str | None = None, parameters: dict | None = None, dataId: ~lsst.daf.butler.core.dimensions._coordinate.DataCoordinate = <factory>)¶
Bases:
object
An in-memory version of a
DeferredDatasetHandle
.Attributes Summary
Optional parameters that may be used to specify a subset of the dataset to be loaded (
dict
orNone
).The name of the
StorageClass
associated with this dataset.Methods Summary
get
(*[, component, parameters, storageClass])Retrieves the dataset pointed to by this handle
Attributes Documentation
- parameters: dict | None = None¶
Optional parameters that may be used to specify a subset of the dataset to be loaded (
dict
orNone
).
- storageClass: str | None = None¶
The name of the
StorageClass
associated with this dataset.If
None
, the storage class will be looked up from the factory.
Methods Documentation
- get(*, component: str | None = None, parameters: dict | None = None, storageClass: str | StorageClass | None = None) Any ¶
Retrieves the dataset pointed to by this handle
This handle may be used multiple times, possibly with different parameters.
- Parameters:
- component
str
or None If the deferred object is a component dataset type, this parameter may specify the name of the component to use in the get operation.
- parameters
dict
or None The parameters argument will be passed to the butler get method. It defaults to None. If the value is not None, this dict will be merged with the parameters dict used to construct the
DeferredDatasetHandle
class.- storageClass
StorageClass
orstr
, optional The storage class to be used to override the Python type returned by this method. By default the returned type matches the type stored. Specifying a read
StorageClass
can force a different type to be returned. This type must be compatible with the original type.
- component
- Returns:
- Raises:
- KeyError
Raised if a component or parameters are used but no storage class can be found.