Add subwidget parameters for UnitSummaryWidget

[florian6973]

Hi,

As discussed in #3222, here is a very small PR to add this feature. Please let me know if you would like any changes before merging.

To test:

import spikeinterface.full as si
import spikeinterface.widgets as sw
rec, sort = si.generate_ground_truth_recording(num_channels=4)
sa = si.create_sorting_analyzer(sort, rec)
sa.compute(["random_spikes", "templates", "spike_amplitudes", "waveforms"])
sw.plot_unit_summary(sa, 0, unitwaveformswidget_params={"plot_channels": True}, amplitudeswidget_params={"bins": 20})

Best,

[zm711]

Maybe @samuelgarcia would feel differently, but I would actually like the idea of a nested dict instead of multiple dicts. Maybe @h-mayorquin would also like to weigh in on the design choice. So it would be something like

widget_param_dict = dict(amplitude_params=xx, etc)

And then if None you make an empty dict and just iterate through the keys to create your sub dictionaries. That way if we changes the widgets it would be easy to change that internally without breaking the external API.

[florian6973]

Thanks for your feedback! I just did the change to a nested dict :)

[alejoe91]

Thanks @florian6973

I have a suggestion on the naming of the additional params

[florian6973]

Thanks for your suggestion! Just implemented the changes.

Example:

import spikeinterface.full as si
import spikeinterface.widgets as sw
rec, sort = si.generate_ground_truth_recording(num_channels=4)
sa = si.create_sorting_analyzer(sort, rec)
sa.compute(["random_spikes", "templates", "spike_amplitudes", "waveforms"])
sw.plot_unit_summary(sa, 0, widget_params=dict(unit_waveforms={"plot_channels": True}, amplitudes={"bins": 5}))

[JoeZiminski]

cool! I did not know about that defaultdict. Might be adding a quick comment like # Returns an empty dict if the key is not in passed in dp.widget_params, but maybe this is quite widely known and doesn't need the comment

[florian6973]

Just added a comment :)

[JoeZiminski]

Hey @florian6973 this is really cool! I played around with it and it was working well. I had one small point above and two below, please feel free to ignore them they are minor.

• the widget_params could be renamed to widget_kwargs which I think (?) is usually the convention in SI for kwargs that are passed down the call chain to subfunctions / classes. Maybe this could also be subwidget_kwargs to distinguish it from the other arguments of the function (technically all of the params passed are 'widget params', for the UnitSummaryWidget).
• I naively tried to pass unit_colors to one of the subwidget and it raised a slightly confusing error (the subwidget received two duplicate unit_colors arguments), as that is already handled by the UnitSummaryWidget. So it's not possible to override this in the widget_params. Some options would be to raise an error saying this is not supported, or just add to the docstring to that effect, or to override the unit_colors for the subwidget if it is passed in the dict. This is an edge-case so docstring is probably easiest!

[florian6973]

Thanks for your feedback! Just pushed some changes to rename the variables and add a clearer error message for this edge case.

import spikeinterface.full as si
import spikeinterface.widgets as sw
rec, sort = si.generate_ground_truth_recording(num_channels=4)
sa = si.create_sorting_analyzer(sort, rec)
sa.compute(["random_spikes", "templates", "spike_amplitudes", "waveforms"])
sw.plot_unit_summary(sa, 0, unit_colors=['r'], subwidget_kwargs=dict(unit_waveforms={"plot_channels": True}, amplitudes={"bins": 5}))
                     
from matplotlib import pyplot as plt
plt.show()

[alejoe91]

Add space before colon

[florian6973]

Oh so sorry! Thank you for adding them again

[zm711]

Thanks Florent!