pyUSID.io.hdf_utils.simple.write_ind_val_dsets

pyUSID.io.hdf_utils.simple.write_ind_val_dsets(h5_parent_group, dimensions, is_spectral=True, verbose=False, base_name=None, slow_to_fast=False)[source]

Creates h5py.Datasets for the position OR spectroscopic indices and values of the data. Remember that the contents of the dataset can be changed if need be after the creation of the datasets. For example if one of the spectroscopic dimensions (e.g. - Bias) was sinusoidal and not linear, The specific dimension in the Spectroscopic_Values dataset can be manually overwritten.

Parameters:

  • h5_parent_group (h5py.Group or h5py.File) – Group under which the indices and values datasets will be created

  • dimensions (Dimension or array-like of Dimension objects) – Sequence of Dimension objects that provides all necessary instructions for constructing the indices and values datasets

  • is_spectral (bool, optional. default = True) – Spectroscopic (True) or Position (False)

  • verbose (Boolean, optional) – Whether or not to print statements for debugging purposes

  • base_name (str or unicode, optional) – Prefix for the datasets. Default: ‘Position’ when is_spectral is False, ‘Spectroscopic’ otherwise

  • slow_to_fast (bool, Optional. Default=False) – Set to True if the dimensions are arranged from slowest varying to fastest varying. Set to False otherwise.

Returns:

  • h5_spec_inds (h5py.Dataset) – Dataset containing the position indices

  • h5_spec_vals (h5py.Dataset) – Dataset containing the value at each position

Notes

steps, initial_values, labels, and ‘units’ must be the same length as dimensions when they are specified.

Dimensions should be in the order from fastest varying to slowest.