pyNSID.io.hdf_utils.validate_main_and_dims

pyNSID.io.hdf_utils.validate_main_and_dims(main_shape, dim_dict, h5_parent_group)[source]

Validates the shape of the main dataset against the dictionary of dimensions and the parent HDF5 group into which the data would be written. This method was written as a low-level validation check before sidpy.Dataset was conceived. It may still be relevant if one intends to reuse the Dimension HDF5 datasets already in the file

Parameters

  • main_shape (list or tuple) – Shape of the Main dataset

  • dim_dict (dict) – Dictionary of dimensions that could either be sidpy.Dimension or h5py.Dataset objects

  • h5_parent_group (h5py.Group) – HDF5 group to write into

Returns

Whether or not the dimensions match the main data shape

Return type

bool