CompositesMap

class lsst.daf.butler.CompositesMap(config: Union[str, ButlerConfig, CompositesConfig], *, universe: DimensionUniverse)

Bases: object

Determine whether something should be disassembled.

Compares a DatasetType or StorageClass with the map and determines whether disassembly is requested.

Parameters:

config : str, ButlerConfig, or CompositesConfig

Configuration to control composites disassembly.

universe : DimensionUniverse

Set of all known dimensions, used to expand and validate any used in lookup keys.

Methods Summary

shouldBeDisassembled(entity, DatasetType, …)

Indicate whether the entity should be disassembled.

Methods Documentation

shouldBeDisassembled(entity: Union[DatasetRef, DatasetType, StorageClass]) → bool

Indicate whether the entity should be disassembled.

Parameters:

entity : StorageClass or DatasetType or DatasetRef

Thing to test against the configuration. The name property is used to determine a match. A DatasetType will first check its name, before checking its StorageClass. If there are no matches the default will be returned. If the associated StorageClass is not a composite, will always return False.

Returns:

disassemble : bool

Returns True if disassembly should occur; False otherwise.

Raises:

ValueError

The supplied argument is not understood.