pyUSID.io.hdf_utils.simple.validate_dims_against_main

pyUSID.io.hdf_utils.simple.validate_dims_against_main(main_shape, dims, is_spectroscopic=True)[source]

Checks Dimension objects against a given shape for main datasets. Errors in parameters will result in Exceptions

Parameters:
  • main_shape (array-like) – Tuple or list with the shape of the main data

  • dims (iterable) – List of Dimension objects

  • is_spectroscopic (bool, Optional. Default = True) – set to True if dims correspond to Spectroscopic Dimensions. False otherwise.