InMemoryDatasetHandle¶
- class lsst.pipe.base.InMemoryDatasetHandle(inMemoryDataset: Any, *, storageClass: StorageClass | str | None = None, parameters: dict[str, Any] | None = None, dataId: DataCoordinate | Mapping[str, Any] | None = None, copy: bool = False, **kwargs: Any)¶
Bases:
object
An in-memory version of a
DeferredDatasetHandle
.- Parameters:
- inMemoryDataset
Any
The dataset to be used by this handle.
- storageClass
StorageClass
orNone
, optional The storage class associated with the in-memory dataset. If
None
and if a storage class is needed, an attempt will be made to work one out from the underlying python type.- parameters
dict
[str
,Any
] Parameters to be used with
get
.- dataId
DataId
orNone
, optional The dataId associated with this dataset. Only used for compatibility with the Butler implementation. Can be used for logging messages by calling code. If
dataId
is not specified, a default empty dataId will be constructed.- copy
bool
, optional Whether to copy on
get
or not.- **kwargs
Any
If
kwargs
are provided without specifying adataId
, those parameters will be converted into a dataId-like entity.
- inMemoryDataset
Attributes Summary
Control whether a copy of the in-memory dataset is returned for every call to
get()
.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])Retrieve the dataset pointed to by this handle.
Attributes Documentation
- copy: bool = False¶
Control whether a copy of the in-memory dataset is returned for every call to
get()
.
- parameters: dict | None = None¶
Optional parameters that may be used to specify a subset of the dataset to be loaded (
dict
orNone
).
- storageClass: 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 ¶
Retrieve 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 notNone
, thisdict
will be merged with the parameters dict used to construct theDeferredDatasetHandle
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:
- return
object
The dataset pointed to by this handle. Whether this returns the original object or a copy is controlled by the
copy
property of the handle that is set at handle construction time. If the stored object isNone
this method always returnsNone
regardless of any component request or parameters.
- return
- Raises:
- KeyError
Raised if a component or parameters are used but no storage class can be found.