Fix: enhance refresh_plot method to include options for only_visible and only_existing items

PierreRaybaut · PierreRaybaut · commit c684a48c7e77 · 2025-04-07T19:13:02.000+02:00
Fix #161
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,6 +16,7 @@ See DataLab [roadmap page](https://datalab-platform.com/en/contributing/roadmap.
 * Fixed [Issue #158](https://github.com./DataLab-Platform/DataLab/issues/158) - When editing ROI of a list of images, the first image of the selection is shown (instead of the last as in the image panel)
 * Fixed [Issue #159](https://github.com./DataLab-Platform/DataLab/issues/159) - When selecting multiple images just after opening an HDF5 file, the "View in a new window" feature does not work (`KeyError` exception)
 * Fixed [Issue #160](https://github.com./DataLab-Platform/DataLab/issues/160) - When selecting multiple images and clearing ROI in ROI editor, only the first image is affected
+* Fixed [Issue #161](https://github.com./DataLab-Platform/DataLab/issues/161) - Refresh image items only if necessary (when editing ROI, pasting/deleting metadata)
 
 ## DataLab Version 0.19.0 ##
 
diff --git a/cdl/core/gui/panel/base.py b/cdl/core/gui/panel/base.py
@@ -280,7 +280,7 @@ class BaseDataPanel(AbstractPanel, Generic[TypeObj, TypeROI, TypeROIEditor]):
     IO_REGISTRY: SignalIORegistry | ImageIORegistry | None = None
     SIG_STATUS_MESSAGE = QC.Signal(str)  # emitted by "qt_try_except" decorator
     SIG_REFRESH_PLOT = QC.Signal(
-        str, bool, bool
+        str, bool, bool, bool, bool
     )  # Connected to PlotHandler.refresh_plot
     ROIDIALOGOPTIONS = {}
 
@@ -475,10 +475,14 @@ def setup_panel(self) -> None:
         self.add_objprop_buttons()
 
     def refresh_plot(
-        self, what: str, update_items: bool = True, force: bool = False
+        self,
+        what: str,
+        update_items: bool = True,
+        force: bool = False,
+        only_visible: bool = True,
+        only_existing: bool = False,
     ) -> None:
-        """Refresh plot. This method simply emits the signal SIG_REFRESH_PLOT which is
-        connected to the method `PlotHandler.refresh_plot`.
+        """Refresh plot.
 
         Args:
             what: string describing the objects to refresh.
@@ -489,17 +493,26 @@ def refresh_plot(
              If False, only show the items (do not update them, except if the
              option "Use reference item LUT range" is enabled and more than one
              item is selected). Defaults to True.
-            force: if True, force refresh even if auto refresh is disabled,
-             and refresh all items associated to objects (even the hidden ones, e.g.
-             when selecting multiple images of the same size and position). Defaults
-             to False.
+            force: if True, force refresh even if auto refresh is disabled.
+             Defaults to False.
+            only_visible: if True, only refresh visible items. Defaults to True.
+             Visible items are the ones that are not hidden by other items or the items
+             except the first one if the option "Show first only" is enabled.
+             This is useful for images, where the last image is the one that is shown.
+             If False, all items are refreshed.
+            only_existing: if True, only refresh existing items. Defaults to False.
+             Existing items are the ones that have already been created and are
+             associated to the object uuid. If False, create new items for the
+             objects that do not have an item yet.
 
         Raises:
             ValueError: if `what` is not a valid value
         """
         if what not in ("selected", "all", "existing") and not isinstance(what, str):
             raise ValueError(f"Invalid value for 'what': {what}")
-        self.SIG_REFRESH_PLOT.emit(what, update_items, force)
+        self.SIG_REFRESH_PLOT.emit(
+            what, update_items, force, only_visible, only_existing
+        )
 
     def manual_refresh(self) -> None:
         """Manual refresh"""
@@ -622,10 +635,12 @@ def paste_metadata(self, param: PasteMetadataParam | None = None) -> None:
         sel_objects = self.objview.get_sel_objects(include_groups=True)
         for obj in sorted(sel_objects, key=lambda obj: obj.short_id, reverse=True):
             obj.update_metadata_from(metadata)
-        # We have to do a manual refresh in order to force the plot handler to update
+        # We have to do a special refresh in order to force the plot handler to update
         # all plot items, even the ones that are not visible (otherwise, image masks
         # would not be updated after pasting the metadata: see issue #123)
-        self.manual_refresh()
+        self.refresh_plot(
+            "selected", update_items=True, only_visible=False, only_existing=True
+        )
 
     def remove_object(self, force: bool = False) -> None:
         """Remove signal/image object
@@ -716,11 +731,13 @@ def delete_metadata(
             if index == 0:
                 self.selection_changed()
         if refresh_plot:
-            # We have to do a manual refresh in order to force the plot handler to
+            # We have to do a special refresh in order to force the plot handler to
             # update all plot items, even the ones that are not visible (otherwise,
             # image masks would remained visible after deleting the ROI for example:
             # see issue #122)
-            self.manual_refresh()
+            self.refresh_plot(
+                "selected", update_items=True, only_visible=False, only_existing=True
+            )
 
     def add_annotations_from_items(
         self, items: list, refresh_plot: bool = True
diff --git a/cdl/core/gui/plothandler.py b/cdl/core/gui/plothandler.py
@@ -99,7 +99,7 @@ def __getitem__(self, oid: str) -> TypePlotItem:
             # (object has been added to model but the corresponding plot item has not
             # been created yet)
             if not self.__auto_refresh:
-                self.refresh_plot("selected", True, force=True)
+                self.refresh_plot(oid, True, force=True, only_visible=False)
                 return self.__plotitems[oid]
             # Item does not exist and auto refresh is enabled: this should not happen
             raise exc
@@ -282,7 +282,12 @@ def reduce_shown_oids(self, oids: list[str]) -> list[str]:
         return oids
 
     def refresh_plot(
-        self, what: str, update_items: bool = True, force: bool = False
+        self,
+        what: str,
+        update_items: bool = True,
+        force: bool = False,
+        only_visible: bool = True,
+        only_existing: bool = False,
     ) -> None:
         """Refresh plot.
 
@@ -295,10 +300,17 @@ def refresh_plot(
              If False, only show the items (do not update them, except if the
              option "Use reference item LUT range" is enabled and more than one
              item is selected). Defaults to True.
-            force: if True, force refresh even if auto refresh is disabled,
-             and refresh all items associated to objects (even the hidden ones, e.g.
-             when selecting multiple images of the same size and position). Defaults
-             to False.
+            force: if True, force refresh even if auto refresh is disabled.
+             Defaults to False.
+            only_visible: if True, only refresh visible items. Defaults to True.
+             Visible items are the ones that are not hidden by other items or the items
+             except the first one if the option "Show first only" is enabled.
+             This is useful for images, where the last image is the one that is shown.
+             If False, all items are refreshed.
+            only_existing: if True, only refresh existing items. Defaults to False.
+             Existing items are the ones that have already been created and are
+             associated to the object uuid. If False, create new items for the
+             objects that do not have an item yet.
 
         Raises:
             ValueError: if `what` is not a valid value
@@ -344,7 +356,8 @@ def refresh_plot(
         scales_dict = {}
 
         if oids:
-            if what != "existing" and not force:
+            if what != "existing" and only_visible:
+                # Remove hidden items from the list of objects to refresh
                 oids = self.reduce_shown_oids(oids)
             ref_item = None
             with create_progress_bar(
@@ -377,6 +390,8 @@ def refresh_plot(
                     # Update or add item to plot
                     item = self.get(oid)
                     if item is None:
+                        if only_existing:
+                            continue
                         item = self.__add_item_to_plot(oid)
                     else:
                         self.__update_item_on_plot(
@@ -536,7 +551,12 @@ def reduce_shown_oids(self, oids: list[str]) -> list[str]:
         return oids
 
     def refresh_plot(
-        self, what: str, update_items: bool = True, force: bool = False
+        self,
+        what: str,
+        update_items: bool = True,
+        force: bool = False,
+        only_visible: bool = True,
+        only_existing: bool = False,
     ) -> None:
         """Refresh plot.
 
@@ -549,15 +569,28 @@ def refresh_plot(
              If False, only show the items (do not update them, except if the
              option "Use reference item LUT range" is enabled and more than one
              item is selected). Defaults to True.
-            force: if True, force refresh even if auto refresh is disabled,
-             and refresh all items associated to objects (even the hidden ones, e.g.
-             when selecting multiple images of the same size and position). Defaults
-             to False.
+            force: if True, force refresh even if auto refresh is disabled.
+             Defaults to False.
+            only_visible: if True, only refresh visible items. Defaults to True.
+             Visible items are the ones that are not hidden by other items or the items
+             except the first one if the option "Show first only" is enabled.
+             This is useful for images, where the last image is the one that is shown.
+             If False, all items are refreshed.
+            only_existing: if True, only refresh existing items. Defaults to False.
+             Existing items are the ones that have already been created and are
+             associated to the object uuid. If False, create new items for the
+             objects that do not have an item yet.
 
         Raises:
             ValueError: if `what` is not a valid value
         """
-        super().refresh_plot(what=what, update_items=update_items, force=force)
+        super().refresh_plot(
+            what=what,
+            update_items=update_items,
+            force=force,
+            only_visible=only_visible,
+            only_existing=only_existing,
+        )
         self.plotwidget.contrast.setVisible(Conf.view.show_contrast.get(True))
 
     def cleanup_dataview(self) -> None:
diff --git a/cdl/core/gui/processor/base.py b/cdl/core/gui/processor/base.py
@@ -1099,7 +1099,12 @@ def edit_regions_of_interest(
                             obj_i.roi = edited_roi
                 self.SIG_ADD_SHAPE.emit(obj.uuid)
                 # self.panel.selection_changed(update_items=True)
-                self.panel.manual_refresh()
+                self.panel.refresh_plot(
+                    "selected",
+                    update_items=True,
+                    only_visible=False,
+                    only_existing=True,
+                )
         return edited_roi
 
     def delete_regions_of_interest(self) -> None:
diff --git a/doc/locale/fr/LC_MESSAGES/api/core.gui/panel.po b/doc/locale/fr/LC_MESSAGES/api/core.gui/panel.po
@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: DataLab \n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2025-03-31 09:43+0200\n"
+"POT-Creation-Date: 2025-04-07 19:11+0200\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language: fr\n"
@@ -17,7 +17,7 @@ msgstr ""
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=utf-8\n"
 "Content-Transfer-Encoding: 8bit\n"
-"Generated-By: Babel 2.17.0\n"
+"Generated-By: Babel 2.14.0\n"
 
 msgid "Panel"
 msgstr "Panneau"
@@ -202,7 +202,7 @@ msgstr ""
 msgid "Setup panel"
 msgstr ""
 
-msgid "Refresh plot. This method simply emits the signal SIG_REFRESH_PLOT which is connected to the method `PlotHandler.refresh_plot`."
+msgid "Refresh plot."
 msgstr ""
 
 msgid "string describing the objects to refresh. Valid values are \"selected\" (refresh the selected objects), \"all\" (refresh all objects), \"existing\" (refresh existing plot items), or an object uuid."
@@ -211,7 +211,13 @@ msgstr ""
 msgid "if True, update the items. If False, only show the items (do not update them, except if the option \"Use reference item LUT range\" is enabled and more than one item is selected). Defaults to True."
 msgstr ""
 
-msgid "if True, force refresh even if auto refresh is disabled, and refresh all items associated to objects (even the hidden ones, e.g. when selecting multiple images of the same size and position). Defaults to False."
+msgid "if True, force refresh even if auto refresh is disabled. Defaults to False."
+msgstr ""
+
+msgid "if True, only refresh visible items. Defaults to True. Visible items are the ones that are not hidden by other items or the items except the first one if the option \"Show first only\" is enabled. This is useful for images, where the last image is the one that is shown. If False, all items are refreshed."
+msgstr ""
+
+msgid "if True, only refresh existing items. Defaults to False. Existing items are the ones that have already been created and are associated to the object uuid. If False, create new items for the objects that do not have an item yet."
 msgstr ""
 
 msgid "Raises"
diff --git a/doc/locale/fr/LC_MESSAGES/api/core.gui/plothandler.po b/doc/locale/fr/LC_MESSAGES/api/core.gui/plothandler.po
@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: DataLab \n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2025-03-20 14:15+0100\n"
+"POT-Creation-Date: 2025-04-07 19:11+0200\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language: fr\n"
@@ -17,7 +17,7 @@ msgstr ""
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=utf-8\n"
 "Content-Transfer-Encoding: 8bit\n"
-"Generated-By: Babel 2.17.0\n"
+"Generated-By: Babel 2.14.0\n"
 
 msgid "Plot handler"
 msgstr "Gestionnaire de visualisation"
@@ -85,7 +85,13 @@ msgstr "chaîne décrivant les objets à actualiser. Les valeurs valides sont \"
 msgid "if True, update the items. If False, only show the items (do not update them, except if the option \"Use reference item LUT range\" is enabled and more than one item is selected). Defaults to True."
 msgstr "si True, mettre à jour les items. Si False, seulement afficher les items (ne pas les mettre à jour, sauf si l'option \"Utiliser la plage LUT de l'item de référence\" est activée et que plus d'un item est sélectionné). Par défaut à True."
 
-msgid "if True, force refresh even if auto refresh is disabled, and refresh all items associated to objects (even the hidden ones, e.g. when selecting multiple images of the same size and position). Defaults to False."
+msgid "if True, force refresh even if auto refresh is disabled. Defaults to False."
+msgstr ""
+
+msgid "if True, only refresh visible items. Defaults to True. Visible items are the ones that are not hidden by other items or the items except the first one if the option \"Show first only\" is enabled. This is useful for images, where the last image is the one that is shown. If False, all items are refreshed."
+msgstr ""
+
+msgid "if True, only refresh existing items. Defaults to False. Existing items are the ones that have already been created and are associated to the object uuid. If False, create new items for the objects that do not have an item yet."
 msgstr ""
 
 msgid "Raises"
@@ -123,3 +129,4 @@ msgstr "Gestionnaire de visualisation d'images"
 
 msgid "Object handling image plot items, plot dialogs, plot options"
 msgstr "Objet gérant les items de visualisation d'images, les dialogues de visualisation et les options de visualisation"
+
diff --git a/doc/locale/fr/LC_MESSAGES/contributing/changelog.po b/doc/locale/fr/LC_MESSAGES/contributing/changelog.po
@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: DataLab \n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2025-04-07 18:28+0200\n"
+"POT-Creation-Date: 2025-04-07 19:11+0200\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language: fr\n"
@@ -60,6 +60,9 @@ msgstr "Correction de l'[Issue #159](https://github.com./DataLab-Platform/DataLab
 msgid "Fixed [Issue #160](https://github.com./DataLab-Platform/DataLab/issues/160) - When selecting multiple images and clearing ROI in ROI editor, only the first image is affected"
 msgstr "Correction de l'[Issue #160](https://github.com./DataLab-Platform/DataLab/issues/160) - Lors de la sélection de plusieurs images et de l'effacement de la ROI dans l'éditeur de ROI, seule la première image est affectée"
 
+msgid "Fixed [Issue #161](https://github.com./DataLab-Platform/DataLab/issues/161) - Refresh image items only if necessary (when editing ROI, pasting/deleting metadata)"
+msgstr "Correction de l'[Issue #161](https://github.com./DataLab-Platform/DataLab/issues/161) - Rafraîchir les items d'image uniquement si nécessaire (lors de l'édition de la ROI, du collage/de la suppression de métadonnées)"
+
 msgid "DataLab Version 0.19.0"
 msgstr "DataLab Version 0.19.0"
 
