LookupKey¶
-
class
lsst.daf.butler.
LookupKey
(name: Optional[str] = None, dimensions: Optional[Iterable[Union[str, Dimension]]] = None, dataId: Optional[Dict[str, Any]] = None, *, universe: Optional[DimensionUniverse] = None)¶ Bases:
object
Representation of key that can be used to lookup information 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 aDimensionGraph
and stored indimensions
property.- dimensions :
DimensionGraph
, 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 fullDimensionGraph
is not provided.
Attributes Summary
dataId
Dict of keys/values that are important for dataId lookup. dimensions
Dimensions associated with lookup. name
Primary name string to use as lookup. Methods Summary
clone
(name, dimensions, dataId, Any]] = None)Clone the object, overriding some options. Attributes Documentation
-
dimensions
¶ Dimensions associated with lookup. (
DimensionGraph
)
Methods Documentation
-
clone
(name: Optional[str] = None, dimensions: Optional[lsst.daf.butler.core.dimensions._graph.DimensionGraph] = None, dataId: Optional[Dict[str, Any]] = None) → lsst.daf.butler.core.configSupport.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 :
DimensionGraph
, 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.
Returns: - clone :
LookupKey
Copy with updates.
- name :
- name :