pyUSID.io.hdf_utils.simple.check_if_main

pyUSID.io.hdf_utils.simple.check_if_main(h5_main, verbose=False)[source]

Checks the input dataset to see if it has all the necessary features to be considered a Main dataset. This means it is 2D and has the following attributes:

  • Position_Indices

  • Position_Values

  • Spectroscopic_Indices

  • Spectroscopic_Values

  • quantity

  • units

In addition, the shapes of the ancillary matrices should match with that of h5_main

Parameters:

  • h5_main (HDF5 Dataset) – Dataset of interest

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

Returns:

success – True if all tests pass

Return type:

Boolean