sidpy.hdf.reg_ref.attempt_reg_ref_build

sidpy.hdf.reg_ref.attempt_reg_ref_build(h5_dset, dim_names, verbose=False)[source]

Attempts to build region references

Parameters:

  • h5_dset (h5.Dataset instance) – Dataset to which region references need to be added as attributes

  • dim_names (list or tuple) – List of the names of the region references (typically names of dimensions)

  • verbose (bool, optional. Default=False) – Whether or not to print debugging statements

Returns:

labels_dict – The slicing information must be formatted using tuples of slice objects For example {‘region_1’:(slice(None, None), slice (0,1))}

Return type:

dict