GovernorDimensionRestriction

class lsst.daf.butler.registry.wildcards.GovernorDimensionRestriction(universe: lsst.daf.butler.core.dimensions._universe.DimensionUniverse, **kwargs)

Bases: object

An object that represents a restriction on some entity to only certain values of the governor dimensions.

Parameters:

universe : DimensionUniverse

Object managing all dimensions.

kwargs : str or Iterable [ str ]

Dimension values to restrict to, keyed by dimension name.

Attributes Summary

mapping

A NamedKeyMapping view of this restriction, with all restricted dimensions as keys and sets of allowed data ID values as dictionary values.

Methods Summary

isConsistentWith(dataId)	Test whether this restriction is consistent with the given data ID.
union(universe, *args)	Merge one or more GovernorDimensionRestriction instances.

Attributes Documentation

mapping

A NamedKeyMapping view of this restriction, with all restricted dimensions as keys and sets of allowed data ID values as dictionary values.

Methods Documentation

isConsistentWith(dataId: lsst.daf.butler.core.dimensions._coordinate.DataCoordinate) → bool

Test whether this restriction is consistent with the given data ID.

Parameters:

dataId : DataCoordinate

Data ID to test.

Returns:

consistent : bool

True if all values the data ID are either not restricted by self, or are included in self.

static union(universe: lsst.daf.butler.core.dimensions._universe.DimensionUniverse, *args) → lsst.daf.butler.registry.wildcards.GovernorDimensionRestriction

Merge one or more GovernorDimensionRestriction instances.

Parameters:

universe : DimensionUniverse

Object managing all known dimensions.

*args

Additional positional arguments are GovernorDimensionRestriction instances.

Returns:

merged : GovernorDimensionRestriction

A GovernorDimensionRestriction that allows any of the dimension values permitted by any of the inputs.