DataIdPackerDimensions

class lsst.daf.butler.DataIdPackerDimensions(given, required)

Bases: object

A helper class that holds the three categories of dimensions associated with DataIdPacker objects.

Parameters:

given : DimensionGraph

The dimensions that must be provided to construct a DataIdPacker. The packed ID values are only unique and reversible with these dimensions held fixed.

required : DimensionGraph

The dimensions that are identified by the DataId passed to DataIdPacker.pack or returned by DataIdPacker.unpack.

Attributes Summary

given	The dimensions that must be provided to construct a DataIdPacker (DimensionSet)
required	The dimensions that must be present in a DataId for it to be packed (DimensionSet).
universe	A graph containing all known dimensions (DimensionGraph).

Methods Summary

fromConfig(universe, config)

Construct from a Config subset.

Attributes Documentation

given

The dimensions that must be provided to construct a DataIdPacker (DimensionSet)

The packed ID values are only unique and reversible with these dimensions held fixed.

required

The dimensions that must be present in a DataId for it to be packed (DimensionSet).

universe

A graph containing all known dimensions (DimensionGraph).

Methods Documentation

classmethod fromConfig(universe, config)

Construct from a Config subset.

Parameters:

universe : DimensionGraph

A graph containing all known Dimension instances.

config : Config

A config with “given” and “covered” keys that map to lists of Dimension names.