ROI editor: activate ROI selection tool by default, so that the user can select right away the area to be used as a ROI

Fix #154

Author: PierreRaybaut

CHANGELOG.md

@@ -6,6 +6,13 @@ See DataLab [roadmap page](https://datalab-platform.com/en/contributing/roadmap.
 
 💥 New features and enhancements:
 
+* Region of Interest (ROI) editor:
+  * This concerns the "Edit Regions of Interest" feature for both signals and images
+  * New behavior:
+    * Signals: the range ROI selection tool is now active by default, and the user can select right away the range of the signal to be used as a ROI
+    * Images: the rectangular ROI selection tool is now active by default, and the user can select right away the rectangular ROI to be used as a ROI
+    * This closes [Issue #154](https://github.com/DataLab-Platform/DataLab/issues/154) - ROI editor: activate ROI selection tool by default, so that the user can select right away the area to be used as a ROI
+  * Added the "Select tool" to editor's toolbar, to allow the user to switch between the "Select" and "Draw" tools easily without having to use the plot toolbar on the top of the window
 * Signal processing features ("Processing" menu):
   * New "X-Y mode" feature: this feature simulates the behavior of the X-Y mode of an oscilloscope, i.e. it allows to plot one signal as a function of another signal (e.g. X as a function of Y)
 

cdl/core/gui/roieditor.py

@@ -41,7 +41,7 @@
     XRangeSelection,
 )
 from plotpy.plot import PlotDialog, PlotManager
-from plotpy.tools import CircleTool, HRangeTool, PolygonTool, RectangleTool
+from plotpy.tools import CircleTool, HRangeTool, PolygonTool, RectangleTool, SelectTool
 from qtpy import QtCore as QC
 from qtpy import QtWidgets as QW
 
@@ -94,11 +94,10 @@ def configure_roi_item_in_tool(shape, obj: dlo.SignalObj | dlo.ImageObj) -> None
     configure_roi_item(shape, fmt, lbl=True, editable=True, option=obj.PREFIX)
 
 
-def tool_activate(tool: InteractiveTool) -> None:
-    """Tool activate"""
+def tool_deselect_items(tool: InteractiveTool) -> None:
+    """Deselect all items in plot associated with the tool"""
     plot = tool.get_active_plot()
     plot.select_some_items([])  # Deselect all items
-    tool.activate()
 
 
 def tool_setup_shape(shape: TypeROIItem, obj: dlo.SignalObj | dlo.ImageObj) -> None:
@@ -114,10 +113,14 @@ class ROISegmentTool(HRangeTool):
     ICON = "signal_roi.svg"
 
     def __init__(self, manager: PlotManager, obj: dlo.SignalObj) -> None:
-        super().__init__(manager, switch_to_default_tool=True, toolbar_id=None)
+        super().__init__(manager, switch_to_default_tool=False, toolbar_id=None)
         self.roi = SegmentROI([0, 1], False)
         self.obj = obj
-        self.activate = tool_activate
+
+    def activate(self):
+        """Activate tool"""
+        tool_deselect_items(self)
+        super().activate()
 
     def create_shape(self) -> XRangeSelection:
         """Create shape"""
@@ -135,13 +138,17 @@ class ROIRectangleTool(RectangleTool):
     def __init__(self, manager: PlotManager, obj: dlo.ImageObj) -> None:
         super().__init__(
             manager,
-            switch_to_default_tool=True,
+            switch_to_default_tool=False,
             toolbar_id=None,
             setup_shape_cb=tool_setup_shape,
         )
         self.roi = RectangularROI([0, 0, 1, 1], True)
         self.obj = obj
-        self.activate = tool_activate
+
+    def activate(self):
+        """Activate tool"""
+        tool_deselect_items(self)
+        super().activate()
 
     def create_shape(self) -> tuple[AnnotatedRectangle, int, int]:
         """Create shape"""
@@ -162,13 +169,17 @@ class ROICircleTool(CircleTool):
     def __init__(self, manager: PlotManager, obj: dlo.ImageObj) -> None:
         super().__init__(
             manager,
-            switch_to_default_tool=True,
+            switch_to_default_tool=False,
             toolbar_id=None,
             setup_shape_cb=tool_setup_shape,
         )
         self.roi = CircularROI([0, 0, 1], True)
         self.obj = obj
-        self.activate = tool_activate
+
+    def activate(self):
+        """Activate tool"""
+        tool_deselect_items(self)
+        super().activate()
 
     def create_shape(self) -> tuple[AnnotatedCircle, int, int]:
         """Create shape"""
@@ -189,13 +200,17 @@ class ROIPolygonTool(PolygonTool):
     def __init__(self, manager: PlotManager, obj: dlo.ImageObj) -> None:
         super().__init__(
             manager,
-            switch_to_default_tool=True,
+            switch_to_default_tool=False,
             toolbar_id=None,
             setup_shape_cb=tool_setup_shape,
         )
         self.roi = PolygonalROI([[0, 0], [1, 0], [1, 1], [0, 1]], True)
         self.obj = obj
-        self.activate = tool_activate
+
+    def activate(self):
+        """Activate tool"""
+        tool_deselect_items(self)
+        super().activate()
 
     def create_shape(self) -> tuple[AnnotatedPolygon, int, int]:
         """Create shape"""
@@ -251,6 +266,9 @@ def __init__(
             self.__roi.iterate_roi_items(obj, fmt, True, True)
         )
 
+        mgr = self.plot_dialog.get_manager()
+        select_tool = mgr.get_tool(SelectTool)
+        add_actions(self.toolbar, [select_tool.action])
         self.add_tools_to_plot_dialog()
         item = obj.make_item() if item is None else item
         item.set_selectable(False)
@@ -371,7 +389,7 @@ def setup_widget(self) -> None:
         layout.addWidget(self.toolbar)
         if self.extract:
             self.singleobj_btn = QW.QCheckBox(
-                _("Extract all ROIs into a single %s object") % self.OBJ_NAME,
+                _("Extract all ROIs\ninto a single %s") % self.OBJ_NAME,
                 self,
             )
             layout.addWidget(self.singleobj_btn)
@@ -456,6 +474,7 @@ def add_tools_to_plot_dialog(self) -> None:
         mgr = self.plot_dialog.get_manager()
         segm_tool = mgr.add_tool(ROISegmentTool, self.obj)
         self._tools.append(segm_tool)
+        segm_tool.activate()
 
     def manually_add_roi(self) -> None:
         """Manually add segment ROI"""
@@ -517,6 +536,7 @@ def add_tools_to_plot_dialog(self) -> None:
         circ_tool = mgr.add_tool(ROICircleTool, self.obj)
         poly_tool = mgr.add_tool(ROIPolygonTool, self.obj)
         self._tools.extend([rect_tool, circ_tool, poly_tool])
+        rect_tool.activate()
 
     def manually_add_roi(
         self, roi_type: Literal["rectangle", "circle", "polygon"]

cdl/locale/fr/LC_MESSAGES/cdl.po

@@ -4,7 +4,7 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
-"POT-Creation-Date: 2025-04-03 14:36+0200\n"
+"POT-Creation-Date: 2025-04-05 11:49+0200\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -2305,8 +2305,8 @@ msgstr "ROI par coordonnées"
 msgid "Remove all"
 msgstr "Supprimer tout"
 
-msgid "Extract all ROIs into a single %s object"
-msgstr "Extraire toutes les ROI dans un seul objet %s"
+msgid "Extract all ROIs\ninto a single %s"
+msgstr "Extraire toutes les ROI\ndans un seul objet %s"
 
 msgid "Remove all ROIs"
 msgstr "Supprimer toutes les ROI"

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-05 10:44+0200\n"
+"POT-Creation-Date: 2025-04-05 11:54+0200\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language: fr\n"
@@ -30,6 +30,27 @@ msgstr "DataLab Version 0.20.0"
 msgid "💥 New features and enhancements:"
 msgstr "💥 Nouvelles fonctionnalités et améliorations :"
 
+msgid "Region of Interest (ROI) editor:"
+msgstr "Éditeur de région d'intérêt (ROI) :"
+
+msgid "This concerns the \"Edit Regions of Interest\" feature for both signals and images"
+msgstr "Cela concerne la fonctionnalité \"Éditer les régions d'intérêt\" pour les signaux et les images"
+
+msgid "New behavior:"
+msgstr "Nouveau comportement :"
+
+msgid "Signals: the range ROI selection tool is now active by default, and the user can select right away the range of the signal to be used as a ROI"
+msgstr "Signaux : l'outil de sélection de la plage ROI est désormais actif par défaut, et l'utilisateur peut sélectionner immédiatement la plage du signal à utiliser comme ROI"
+
+msgid "Images: the rectangular ROI selection tool is now active by default, and the user can select right away the rectangular ROI to be used as a ROI"
+msgstr "Images : l'outil de sélection de la ROI rectangulaire est désormais actif par défaut, et l'utilisateur peut sélectionner immédiatement la ROI rectangulaire à utiliser comme ROI"
+
+msgid "This closes [Issue #154](https://github.com/DataLab-Platform/DataLab/issues/154) - ROI editor: activate ROI selection tool by default, so that the user can select right away the area to be used as a ROI"
+msgstr "Ceci clotûre le ticket [Issue #154](https://github.com/DataLab-Platform/DataLab/issues/154) - Éditeur de ROI : activer l'outil de sélection de ROI par défaut, afin que l'utilisateur puisse sélectionner immédiatement la zone à utiliser comme ROI"
+
+msgid "Added the \"Select tool\" to editor's toolbar, to allow the user to switch between the \"Select\" and \"Draw\" tools easily without having to use the plot toolbar on the top of the window"
+msgstr "Ajout de l'outil \"Sélectionner\" à la barre d'outils de l'éditeur, pour permettre à l'utilisateur de basculer facilement entre les outils \"Sélectionner\" et \"Dessiner\" sans avoir à utiliser la barre d'outils de tracé en haut de la fenêtre"
+
 msgid "Signal processing features (\"Processing\" menu):"
 msgstr "Fonctionnalités de traitement du signal (menu \"Traitement\") :"