sidpy.hdf.reg_ref.write_region_references

sidpy.hdf.reg_ref.write_region_references(h5_dset, reg_ref_dict, add_labels_attr=True, verbose=False)[source]

Creates attributes of a h5py.Dataset that refer to regions in the dataset

Parameters:

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

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

  • add_labels_attr (bool, optional, default = True) – Whether or not to write an attribute named ‘labels’ with the

  • verbose (Boolean (Optional. Default = False)) – Whether or not to print status messages