LookupKey¶
- class lsst.daf.butler.LookupKey(name: str | None = None, dimensions: DimensionGroup | None = None, dataId: dict[str, Any] | None = None, *, universe: DimensionUniverse | None = None)¶
Bases:
object
Representation of key that can be used to lookup information.
Look up is based on dataset type name, storage class name, dimensions.
- Parameters:
- name
str
, optional Primary index string for lookup. If this string looks like it represents dimensions (via
dim1+dim2+dim3
syntax) the name is converted to aDimensionGroup
and stored indimensions
property.- dimensions
DimensionGroup
, optional Dimensions that are relevant for lookup. Should not be specified if
name
is also specified.- dataId
dict
, optional Keys and values from a dataId that should control lookups.
- universe
DimensionUniverse
, optional Set of all known dimensions, used to expand and validate
name
ordimensions
. Required if the key represents dimensions and a fullDimensionGroup
is not provided.
- name
Attributes Summary
Return dict of keys/values that are important for dataId lookup.
Dimensions associated with lookup (
DimensionGroup
).Primary name string to use as lookup (
str
).Methods Summary
clone
([name, dimensions, dataId])Clone the object, overriding some options.
Attributes Documentation
- dimensions¶
Dimensions associated with lookup (
DimensionGroup
).
Methods Documentation
- clone(name: str | None = None, dimensions: DimensionGroup | None = None, dataId: dict[str, Any] | None = None) LookupKey ¶
Clone the object, overriding some options.
Used to create a new instance of the object whilst updating some of it.
- Parameters:
- name
str
, optional Primary index string for lookup. Will override
dimensions
ifdimensions
are set.- dimensions
DimensionGroup
, optional Dimensions that are relevant for lookup. Will override
name
ifname
is already set.- dataId
dict
, optional Keys and values from a dataId that should control lookups.
- name
- Returns:
- clone
LookupKey
Copy with updates.
- clone