Merge pull request #3716 from alejoe91/fix-sv-properties

Fix `extra_properties` propagation in sorting summary and SV string properties

Author: alejoe91

src/spikeinterface/widgets/sorting_summary.py

@@ -56,6 +56,7 @@ class SortingSummaryWidget(BaseWidget):
         analyzer.get_extension("template_metrics").get_data().columns.
     extra_unit_properties : dict or None, default: None
         A dict with extra units properties to display.
+        The key is the property name and the value must be a numpy.array.
     curation_dict : dict or None, default: None
         When curation is True, optionaly the viewer can get a previous 'curation_dict'
         to continue/check  previous curations on this analyzer.
@@ -107,8 +108,8 @@ def __init__(
 
         if displayed_unit_properties is None:
             displayed_unit_properties = list(_default_displayed_unit_properties)
-            if extra_unit_properties is not None:
-                displayed_unit_properties += list(extra_unit_properties.keys())
+        if extra_unit_properties is not None:
+            displayed_unit_properties = displayed_unit_properties + list(extra_unit_properties.keys())
 
         data_plot = dict(
             sorting_analyzer=sorting_analyzer,
@@ -195,7 +196,10 @@ def plot_sortingview(self, data_plot, **backend_kwargs):
 
         # unit ids
         v_units_table = generate_unit_table_view(
-            dp.sorting_analyzer, dp.displayed_unit_properties, similarity_scores=similarity_scores
+            dp.sorting_analyzer,
+            dp.displayed_unit_properties,
+            similarity_scores=similarity_scores,
+            extra_unit_properties=dp.extra_unit_properties,
         )
 
         if dp.curation:

src/spikeinterface/widgets/utils.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+from warnings import warn
 import numpy as np
 
 
@@ -342,5 +343,9 @@ def make_units_table_from_analyzer(
             # the ndim = 1 is important because we need  column only for the display in gui.
             if values.dtype.kind in "iuUSfb" and values.ndim == 1:
                 units_table.loc[:, col] = values
+            else:
+                warn(
+                    f"Extra property {col} not added to the units table because it has ndim > 1 or dtype not supported",
+                )
 
     return units_table

src/spikeinterface/widgets/utils_sortingview.py

@@ -53,12 +53,13 @@ def generate_unit_table_view(
     sorting_or_sorting_analyzer: SortingAnalyzer | BaseSorting,
     unit_properties: list[str] | None = None,
     similarity_scores: np.ndarray | None = None,
+    extra_unit_properties: dict | None = None,
 ):
     import sortingview.views as vv
 
     if isinstance(sorting_or_sorting_analyzer, SortingAnalyzer):
         analyzer = sorting_or_sorting_analyzer
-        units_tables = make_units_table_from_analyzer(analyzer)
+        units_tables = make_units_table_from_analyzer(analyzer, extra_properties=extra_unit_properties)
         sorting = analyzer.sorting
     else:
         sorting = sorting_or_sorting_analyzer
@@ -78,6 +79,8 @@ def generate_unit_table_view(
         units_tables = units_tables.loc[:, unit_properties]
 
         dtype_convertor = {"i": "int", "u": "int", "f": "float", "U": "str", "S": "str", "b": "bool"}
+        # we add "O": "str" because pandas automatically converts strings to Object dtype
+        dtype_convertor["O"] = "str"
 
         ut_columns = []
         for col in unit_properties: