ObservationDimensionPacker¶

class lsst.daf.butler.instrument.ObservationDimensionPacker(*args, **kwargs)¶

A DimensionPacker for visit+detector or exposure+detector, given an instrument.

Deprecated since version v26: Deprecated in favor of configurable dimension packers. Will be removed after v26.

Attributes Summary

`dimensions`	The dimensions of data IDs packed by this instance (`DimensionGraph`).
`maxBits`	Return The maximum number of nonzero bits in the packed ID.
`universe`	Graph containing all known dimensions (`DimensionUniverse`).

Methods Summary

`pack`([dataId, returnMaxBits])	Pack the given data ID into a single integer.
`unpack`(packedId)	Unpack an ID produced by `pack` into a full `DataCoordinate`.

Attributes Documentation

dimensions¶

The dimensions of data IDs packed by this instance (DimensionGraph).

After v27 this will be a DimensionGroup.

Methods Documentation

pack(dataId: DataCoordinate | Mapping[str, Any] | None = None, *, returnMaxBits: bool = False, **kwargs: Any) → tuple[int, int] | int¶

Pack the given data ID into a single integer.

Parameters:

dataIdDataId: Data ID to pack. Values for any keys also present in the “fixed” data ID passed at construction must be the same as the values passed at construction.
returnMaxBitsbool: If True, return a tuple of (packed, self.maxBits).
**kwargs: Additional keyword arguments forwarded to DataCoordinate.standardize.

Returns:

packedint: Packed integer ID.
maxBitsint, optional: Maximum number of nonzero bits in packed. Not returned unless returnMaxBits is True.

Notes

Should not be overridden by derived class (_pack should be overridden instead).

unpack(packedId: int) → DataCoordinate¶

Unpack an ID produced by pack into a full DataCoordinate.

Must be implemented by all concrete derived classes.

Parameters:

packedIdint: The result of a call to pack on either self or an identically-constructed packer instance.

Returns:

dataIdDataCoordinate: Dictionary-like ID that uniquely identifies all covered dimensions.