ImageMapping

class lsst.obs.base.ImageMapping(datasetType, policy, registry, root, **kwargs)

Bases: lsst.obs.base.Mapping

ImageMapping is a Mapping subclass for non-camera images.

Parameters:

datasetType : str

Butler dataset type to be mapped.

policy : daf_persistence.Policy pexPolicy.Policy

Mapping Policy. (pexPolicy only for backward compatibility)

registry : lsst.obs.base.Registry

Registry for metadata lookups

root : str

Path of root directory

Attributes Summary

template

Methods Summary

have(properties, dataId)	Returns whether the provided data identifier has all the properties in the provided list.
keys()	Return the dict of keys and value types required for this mapping.
lookup(properties, dataId)	Look up properties for in a metadata registry given a partial dataset identifier.
map(mapper, dataId[, write])	Standard implementation of map function.
need(properties, dataId)	Ensures all properties in the provided list are present in the data identifier, looking them up as needed.

Attributes Documentation

template

Methods Documentation

have(properties, dataId)

Returns whether the provided data identifier has all the properties in the provided list.

Parameters:

properties : list of `str

Properties required.

dataId : dict

Dataset identifier.

Returns:

bool

True if all properties are present.

keys()

Return the dict of keys and value types required for this mapping.

lookup(properties, dataId)

Look up properties for in a metadata registry given a partial dataset identifier.

Parameters:

properties : list of str

What to look up.

dataId : dict

Dataset identifier

Returns:

list of tuple

Values of properties.

map(mapper, dataId, write=False)

Standard implementation of map function.

Parameters:

mapper: `lsst.daf.persistence.Mapper`

Object to be mapped.

dataId: `dict`

Dataset identifier.

Returns:

lsst.daf.persistence.ButlerLocation

Location of object that was mapped.

need(properties, dataId)

Ensures all properties in the provided list are present in the data identifier, looking them up as needed. This is only possible for the case where the data identifies a single exposure.

Parameters:

properties : list of str

Properties required.

dataId : dict

Partial dataset identifier

Returns:

dict

Copy of dataset identifier with enhanced values.