Merge pull request #197 from chrishalcrow/add-warning-save-curation

Add exit dialog if user has not saved curation

Author: alejoe91

spikeinterface_gui/backend_qt.py

@@ -311,6 +311,19 @@ def make_split(self, zone_index_1, zone_index_2, orientation, widgets_zone, shif
 
     # used by to tell the launcher this is closed
     def closeEvent(self, event):
+
+        if not self.controller.current_curation_saved: 
+            reply = QT.QMessageBox.question(self, 'Confirmation',
+                "You are daydreaming: your curation has not been saved. You can save it at the top of the 'CurationView'.\nDo you still want to quit?", QT.QMessageBox.Yes |
+                QT.QMessageBox.No, QT.QMessageBox.No)
+            if reply == QT.QMessageBox.Yes:
+                # 2. Accept the event to allow closing
+                pass
+            else:
+                # 3. Ignore the event to prevent closing
+                event.ignore()
+                return
+
         self.main_window_closed.emit(self)
         event.accept()
 

spikeinterface_gui/controller.py

@@ -38,9 +38,12 @@ def __init__(self, analyzer=None, backend="qt", parent=None, verbose=False, save
                  extra_unit_properties=None, skip_extensions=None, disable_save_settings_button=False):
         self.views = []
         skip_extensions = skip_extensions if skip_extensions is not None else []
+        
         self.skip_extensions = skip_extensions
         self.backend = backend
         self.disable_save_settings_button = disable_save_settings_button
+        self.current_curation_saved = True
+
         if self.backend == "qt":
             from .backend_qt import SignalHandler
             self.signal_handler = SignalHandler(self, parent=parent)
@@ -802,20 +805,23 @@ def construct_final_curation(self):
 
     def save_curation_in_analyzer(self):
         if self.analyzer.format == "memory":
+            print("Analyzer is an in-memory object. Cannot save curation file in it.")
             pass
         elif self.analyzer.format == "binary_folder":
             folder = self.analyzer.folder / "spikeinterface_gui"
             folder.mkdir(exist_ok=True, parents=True)
             json_file = folder / f"curation_data.json"
             with json_file.open("w") as f:
                 json.dump(check_json(self.construct_final_curation()), f, indent=4)
+            self.current_curation_saved = True
         elif self.analyzer.format == "zarr":
             import zarr
             zarr_root = zarr.open(self.analyzer.folder, mode='r+')
             if "spikeinterface_gui" not in zarr_root.keys():
                 sigui_group = zarr_root.create_group("spikeinterface_gui", overwrite=True)
             sigui_group = zarr_root["spikeinterface_gui"]
             sigui_group.attrs["curation_data"] = check_json(self.construct_final_curation())
+            self.current_curation_saved = True
 
     def get_split_unit_ids(self):
         if not self.curation:

spikeinterface_gui/curationview.py

@@ -292,6 +292,7 @@ def _qt_export_json(self):
             with json_file.open("w") as f:
                 curation_dict = check_json(self.controller.construct_final_curation())
                 json.dump(curation_dict, f, indent=4)
+            self.controller.current_curation_saved = True
 
     # PANEL
     def _panel_make_layout(self):
@@ -469,6 +470,31 @@ def _panel_refresh(self):
         self.table_split.value = df
         self.table_split.selection = []
 
+        if not self.controller.current_curation_saved:
+            self.ensure_save_warning_message()
+        else:
+            self.ensure_no_message()
+
+    def ensure_save_warning_message(self):
+
+        if self.layout[0].name == 'curation_save_warning':
+            return
+
+        import panel as pn
+
+        alert_markdown = pn.pane.Markdown(
+            f"""⚠️⚠️⚠️ Your curation is not saved""",
+            hard_line_break=True,
+            styles={"color": "red", "font-size": "16px"},
+            name="curation_save_warning"
+        )
+
+        self.layout.insert(0, alert_markdown)
+
+    def ensure_no_message(self):
+        if self.layout[0].name == 'curation_save_warning':
+            self.layout.pop(0)
+
     def _panel_update_unit_visibility(self, event):
         unit_dtype = self.controller.unit_ids.dtype
         if self.active_table == "delete":
@@ -501,6 +527,7 @@ def _panel_unmerge(self, event):
 
     def _panel_save_in_analyzer(self, event):
         self.save_in_analyzer()
+        self.refresh()
 
     def _panel_generate_json(self):
         # Get the path from the text input
@@ -511,36 +538,11 @@ def _panel_generate_json(self):
         with open(export_path, "w") as f:
             json.dump(curation_dict, f, indent=4)
 
-        return export_path
-
-    def _panel_get_delete_table_selection(self):
-        selected_items = self.table_delete.selection
-        if len(selected_items) == 0:
-            return None
-        else:
-            return self.table_delete.value["removed"].values[selected_items].tolist()
-
-    def _panel_get_merge_table_row(self):
-        selected_items = self.table_merge.selection
-        if len(selected_items) == 0:
-            return None
-        else:
-            return selected_items
+        self.controller.current_curation_saved = True
 
-    def _panel_get_split_table_row(self):
-        selected_items = self.table_split.selection
-        if len(selected_items) == 0:
-            return None
-        else:
-            return selected_items
+        self.refresh()
 
-    def _panel_handle_shortcut(self, event):
-        if event.data == "restore":
-            self.restore_units()
-        elif event.data == "unmerge":
-            self.unmerge()
-        elif event.data == "unsplit":
-            self.unsplit()
+        return export_path
 
     def _panel_submit_to_parent(self, event):
         """Send the curation data to the parent window"""
@@ -572,6 +574,38 @@ def _panel_submit_to_parent(self, event):
 
         # Update the hidden div with the JavaScript code
         self.data_div.object = js_code
+        # Submitting to parent is a way to "save" the curation (the parent can handle it)
+        self.controller.current_curation_saved = True
+        self.refresh()
+
+    def _panel_get_delete_table_selection(self):
+        selected_items = self.table_delete.selection
+        if len(selected_items) == 0:
+            return None
+        else:
+            return self.table_delete.value["removed"].values[selected_items].tolist()
+
+    def _panel_get_merge_table_row(self):
+        selected_items = self.table_merge.selection
+        if len(selected_items) == 0:
+            return None
+        else:
+            return selected_items
+
+    def _panel_get_split_table_row(self):
+        selected_items = self.table_split.selection
+        if len(selected_items) == 0:
+            return None
+        else:
+            return selected_items
+
+    def _panel_handle_shortcut(self, event):
+        if event.data == "restore":
+            self.restore_units()
+        elif event.data == "unmerge":
+            self.unmerge()
+        elif event.data == "unsplit":
+            self.unsplit()
 
     def _panel_on_unit_visibility_changed(self):
         for table in [self.table_delete, self.table_merge, self.table_split]:

spikeinterface_gui/unitlistview.py

@@ -193,6 +193,8 @@ def _qt_set_default_label(self, label):
         for unit_id in selected_unit_ids:
             self.controller.set_label_to_unit(unit_id, "quality", label)
 
+        self.notify_manual_curation_updated()
+
         selected_rows = self._qt_get_selected_rows()
         for row in selected_rows:
             curation_label = self.table.item(row, self.label_columns[0])
@@ -703,6 +705,7 @@ def _panel_on_edit(self, event):
             if new_label == "":
                 new_label = None
             self.controller.set_label_to_unit(unit_id, column, new_label)
+            self.notify_manual_curation_updated()
         self.notifier.notify_active_view_updated()
 
     def _panel_on_only_selection(self):
@@ -759,16 +762,19 @@ def _panel_handle_shortcut(self, event):
                 for unit_id in selected_unit_ids:
                     self.controller.set_label_to_unit(unit_id, "quality", "good")
                 self.table.value.loc[selected_unit_ids, "quality"] = "good"
+                self.notify_manual_curation_updated()
                 self.refresh()
             elif event.data == "mua":
                 for unit_id in selected_unit_ids:
                     self.controller.set_label_to_unit(unit_id, "quality", "MUA")
                 self.table.value.loc[selected_unit_ids, "quality"] = "MUA"
+                self.notify_manual_curation_updated()
                 self.refresh()
             elif event.data == "noise":
                 for unit_id in selected_unit_ids:
                     self.controller.set_label_to_unit(unit_id, "quality", "noise")
                 self.table.value.loc[selected_unit_ids, "quality"] = "noise"
+                self.notify_manual_curation_updated()
                 self.refresh()
 
 

spikeinterface_gui/view_base.py

@@ -57,6 +57,7 @@ def notify_channel_visibility_changed(self):
         self.notifier.notify_channel_visibility_changed()
 
     def notify_manual_curation_updated(self):
+        self.controller.current_curation_saved = False
         self.notifier.notify_manual_curation_updated()
 
     def notify_time_info_updated(self):