sidpy.viz.jupyter_utils.simple_ndim_visualizer

sidpy.viz.jupyter_utils.simple_ndim_visualizer(data_mat, pos_dims, spec_dims, spec_xdim=None, pos_xdim=None, verbose=False)[source]

Generates a simple visualizer for visualizing simple datasets (up to 4 dimensions). The visualizer will ONLY work within the context of a jupyter notebook!

The visualizer consists of two panels - spatial map and spectrograms. slider widgets will be generated to slice dimensions. The data matrix can be real, complex or compound valued

Parameters:

  • data_mat (numpy.array object) – Data to be visualized

  • pos_dims (list / tuple) – List of Dimension objects specifying all position dimensions in the same order as in data_mat

  • spec_dims (list / tuple) – List of Dimension objects specifying all position dimensions in the same order as in data_mat

  • spec_xdim (str, optional) – Name of dimension with respect to which the spectral data will be plotted for 1D plots

  • pos_xdim (str, optional) – Name of dimension with respect to which the position data will be plotted for 1D plots

  • verbose (bool, optional) – Whether or not to print log statements