NeurodataWithoutBorders / nwbwidgets

Explore the hierarchical structure of NWB 2.0 files and visualize data with Jupyter widgets.
https://nwb-widgets.readthedocs.io/en/latest/
Other
48 stars 21 forks source link

[Feature]: display description of spatial series in CompassDirection #277

Closed CodyCBakerPhD closed 1 month ago

CodyCBakerPhD commented 1 year ago

What would you like to see added to NWB Widgets?

I have a very important description set for an angular SpatialSeries stored in a CompassDirection, but the widgets don't display this like they do for other neurodata types

image

CompassDirection does not have a description field (schema) (PyNWB API) so I can't set it at that level

Perhaps this is something to also fix upstream, but at least for now would it be a problem to display the SpatialSeries description at the CompassDirection level if there is only one spatial series in the container?

Do you have any interest in helping implement the feature?

Yes.

Code of Conduct

bendichter commented 1 year ago

Reproduced with

from pynwb.testing.mock.behavior import mock_CompassDirection
from nwbwidgets.view import nwb2widget

comp_dir = mock_CompassDirection()
nwb2widget(comp_dir)
image
bendichter commented 1 year ago

I'm not sure the best way to solve this in the general sense. One way could be do have a little (i) icon that shows the description of the neurodata type if you hover over it. We could put this icon in the corner for each relevant visualization. This could be part of the base neurodata visualization widget class.