LookupKey

class lsst.daf.butler.LookupKey(name=None, dimensions=None, dataId=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 a DimensionNameSet and stored in dimensions property.

dimensions : DimensionNameSet or 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.

Attributes Summary

dataId	Set of key/value tuples 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])

Clone the object, overriding some options.

Attributes Documentation

dataId

Set of key/value tuples that are important for dataId lookup. (frozenset)

dimensions

Dimensions associated with lookup. (DimensionGraph or DimensionNameSet)

name

Primary name string to use as lookup. (str)

Methods Documentation

clone(name=None, dimensions=None, dataId=None)

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 if dimensions are set.

dimensions : DimensionNameSet, optional

Dimensions that are relevant for lookup. Will override name if name is already set.

dataId : dict, optional

Keys and values from a dataId that should control lookups.

Returns:

clone : LookupKey

Copy with updates.