HDFMapControls

class bapsflib._hdf.maps.controls.map_controls.HDFMapControls(data_group: Group)

Bases: dict

A dictionary that contains mapping objects for all the discovered control devices in the HDF5 data group. The dictionary keys are the names of the discovered control devices.

Parameters:

data_group (h5py.Group) – HDF5 group object to be mapped

Examples

>>> from bapsflib import lapd
>>> from bapsflib._hdf.maps import HDFMapControls
>>> f = lapd.File('sample.hdf5')
>>> # 'Raw data + config' is the LaPD HDF5 group name for the
... # group housing digitizer and control devices
... control_map = HDFMapControls(f['Raw data + config'])
>>> control_map['6K Compumotor']
<bapsflib._hdf.maps.controls.sixk.HDFMapControl6K>

Attributes Summary

mappable_devices

tuple of the mappable control devices (i.e. their HDF5 group names).

Methods Summary

clear()	Remove all items from the dict.
copy()	Return a shallow copy of the dict.
fromkeys(iterable[, value])	Create a new dictionary with keys from iterable and values set to value.
get(key[, default])	Return the value for key if key is in the dictionary, else default.
items()	Return a set-like object providing a view on the dict's items.
keys()	Return a set-like object providing a view on the dict's keys.
pop(k[,d])	If the key is not found, return the default if given; otherwise, raise a KeyError.
popitem()	Remove and return a (key, value) pair as a 2-tuple.
setdefault(key[, default])	Insert key with a value of default if key is not in the dictionary.
update([E, ]**F)	If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values()	Return an object providing a view on the dict's values.

Attributes Documentation

mappable_devices

tuple of the mappable control devices (i.e. their HDF5 group names)

Methods Documentation

clear()

Remove all items from the dict.

copy()

Return a shallow copy of the dict.

classmethod fromkeys(iterable, value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items()

Return a set-like object providing a view on the dict’s items.

keys()

Return a set-like object providing a view on the dict’s keys.

pop(k[, d]) → v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None.  Update D from mapping/iterable E and F.

If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values()

Return an object providing a view on the dict’s values.