DeferredDatasetHandle¶

class lsst.daf.butler.DeferredDatasetHandle(butler: Butler, ref: DatasetRef, parameters: Optional[dict])¶

Proxy class that provides deferred loading of a dataset from a butler.

Attributes Summary

dataId The full data ID associated with the dataset (DataCoordinate).

Methods Summary

get(*, component, parameters, **kwargs) Retrieves the dataset pointed to by this handle

Attributes Documentation

dataId¶

The full data ID associated with the dataset (DataCoordinate).

Guaranteed to contain records.

Methods Documentation

get(*, component: Optional[str] = None, parameters: Optional[dict] = None, **kwargs) → 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.
kwargs : dict: This argument is deprecated and only exists to support legacy gen2 butler code during migration. It is completely ignored and will be removed in the future.

Returns: