pyUSID.io.hdf_utils.model.write_sidpy_dataset

pyUSID.io.hdf_utils.model.write_sidpy_dataset(si_dset, h5_parent_group, verbose=False, **kwargs)[source]

Writes a sidpy.Dataset as a USID dataset in the provided HDF5 Group. Please see notes about dimension types

Parameters:

  • si_dset (sidpy.Dataset) – Dataset to be written to HDF5 in NSID format

  • h5_parent_group (class:h5py.Group) – Parent group under which the datasets will be created

  • verbose (bool, Optional. Default = False) – Whether or not to write logs to standard out

  • kwargs (dict) – additional keyword arguments passed on to h5py when writing data

Returns:

h5_main – Reference to the main dataset

Return type:

USIDataset

Notes

USID only has two dimension types - Position and Spectroscopic. Consider changing the types of dimensions of all other dimensions to either “SPATIAL” or “SPECTRAL”.