BGlib.be.translators.df_utils.be_utils.getIndicesforPlotGroup

BGlib.be.translators.df_utils.be_utils.getIndicesforPlotGroup(h5_udvs_inds, ds_udvs, plt_grp_name)[source]

For a provided plot group name in the udvs table, this function returns the corresponding spectroscopic indices that can be used to index / slice the main data set and the data within the udvs table for the requested plot group * Developer note - Replace the first parameter with the Raw_Data dataset

Parameters:

  • h5_udvs_inds (Reference to HDF5 dataset) – containing the UDVS indices

  • ds_udvs (Reference to HDF5 dataset) – containing the UDVS table

  • plt_grp_name (string) – name of the plot group in the UDVS table

Returns:

  • step_bin_indices (2D numpy array) – Indices arranged as [step, bin] in the spectroscopic_indices table This is useful for knowing the number of bins and steps in this plot group. We are allowed to assume that the number of bins does NOT change within the plot group

  • oneD_indices (1D numpy array) – spectroscopic indices corresponding to the requested plot group

  • udvs_plt_grp_col (1D numpy array) – data contained within the udvs table for the requested plot group