tomwer 1.3.26__py3-none-any.whl → 1.4.0__py3-none-any.whl

tomwer/gui/utils/flow.py

@@ -1,35 +1,7 @@
-# coding: utf-8
-# /*##########################################################################
-#
-# Copyright (c) 2016-2017 European Synchrotron Radiation Facility
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#
-# ###########################################################################*/
-
-__authors__ = ["H. Payno"]
-__license__ = "MIT"
-__date__ = "04/03/2019"
-
+from __future__ import annotations
 
 import functools
-from typing import Union
+from typing import Iterable
 
 from silx.gui import qt
 from silx.utils.enum import Enum as _Enum
@@ -194,7 +166,6 @@ class FlowCanvas(qt.QWidget):
     Widget to describe a flow of process - pipeline
 
     :param direction: direction can be vertical or horizontal
-    :type direction: Union[str,FlowDirection]
     """
 
     sigWidgetActivated = qt.Signal()
@@ -204,7 +175,7 @@ class FlowCanvas(qt.QWidget):
     active process anymore)"""
 
     def __init__(
-        self, parent, direction: Union[str, FlowDirection], show_lock_state=True
+        self, parent, direction: str | FlowDirection, show_lock_state=True
     ) -> None:
         qt.QWidget.__init__(self, parent=parent)
         self._direction = FlowDirection.from_value(direction)
@@ -251,7 +222,6 @@ class FlowCanvas(qt.QWidget):
         :param process_name: any object. Should implement the __str__ interface
                              to define the name if no icon is given
         :return: process id in the process flow
-        :rtype: int
         """
         if icon is None:
             assert hasattr(process, "__str__")
@@ -292,7 +262,7 @@ class FlowCanvas(qt.QWidget):
     def removeProcess(self, process_id: int) -> None:
         """
 
-        :param int process_id: id of the process to remove from the flow
+        :param process_id: id of the process to remove from the flow
         """
         if process_id in self._dockers:
             dockWidget = self._dockers[process_id]
@@ -304,12 +274,14 @@ class FlowCanvas(qt.QWidget):
         for process_id in processes_id:
             self.removeProcess(process_id=process_id)
 
-    def setProcesses(self, processes, icons, draggability) -> None:
+    def setProcesses(
+        self, processes: Iterable, icons: Iterable, draggability: Iterable
+    ) -> None:
         """
 
-        :param Iterable processes: processes of the flow
-        :param Iterable icons: icons associated to the flow
-        :param Iterable draggability: is the process draggable or not
+        :param processes: processes of the flow
+        :param icons: icons associated to the flow
+        :param draggability: is the process draggable or not
         :return:
         """
         for process, icon, draggable in zip(processes, icons, draggability):
@@ -328,11 +300,10 @@ class FlowCanvas(qt.QWidget):
         """
 
         :return: True if the canvas has a process active / focus ...
-        :rtype: bool
         """
         return self.getProcessFocused() is not None
 
-    def getProcessFocused(self) -> Union[None, int]:
+    def getProcessFocused(self) -> int | None:
         """
 
         :return: id of the process focus or None if no process focus

tomwer/gui/utils/gpu.py

@@ -0,0 +1,60 @@
+from __future__ import annotations
+
+from nabu.cuda.utils import collect_cuda_gpus
+from silx.gui import qt
+
+
+class SelectGPUGroupBox(qt.QGroupBox):
+    """Interface to select a (local) GPU"""
+
+    sigGPUChanged = qt.Signal()
+    """Emit when the selected GPU changed"""
+
+    def __init__(self, parent=None, title="select (local) GPU"):
+        super().__init__(parent=parent, title=title)
+        self.setCheckable(True)
+        self.setLayout(qt.QFormLayout())
+        self.__cuda_gpus = collect_cuda_gpus() or {}
+
+        # warn user if no gpu found: reconstruction will work but will take way more time
+        if len(self.__cuda_gpus) == 0:
+            style = qt.QApplication.style()
+            icon = style.standardIcon(qt.QStyle.SP_MessageBoxWarning)
+            self.__iconLabel = qt.QLabel(parent=self)
+            self.__iconLabel.setPixmap(icon.pixmap(80, 80))
+            self.__noGPULabel = qt.QLabel("No cuda GPU detected")
+            self.__noGPULabel.setToolTip(
+                "No cuda GPU device detected. Reconstruction will be done on CPU which is much more slower"
+            )
+            self.layout().addRow(self.__iconLabel, self.__noGPULabel)
+
+        self._gpusCB = qt.QComboBox(self)
+        for gpu_id, gpu_desc in self.__cuda_gpus.items():
+            name = gpu_desc.get("name", f"unknown gpu {gpu_id}")
+            self._gpusCB.addItem(f"{name} (id-{gpu_id})", gpu_id)
+        self.layout().addRow(self._gpusCB)
+
+        # connect signal / slot
+        self._gpusCB.currentIndexChanged.connect(self.__GPUChanged)
+
+    @property
+    def cuda_gpus(self) -> dict:
+        return self.__cudaGPUs
+
+    def getSelectedGPUId(self) -> int | None:
+        if self.isChecked():
+            selected_gpu = self._gpusCB.currentIndex()
+            if selected_gpu == -1:
+                return None
+            else:
+                return self._gpusCB.itemData(selected_gpu, qt.Qt.UserRole)
+        else:
+            return None
+
+    def setSelectedGPUId(self, value: int):
+        cb_index = self._gpusCB.findData(value, role=qt.Qt.UserRole)
+        if cb_index >= 0:
+            self._gpusCB.setCurrentIndex(cb_index)
+
+    def __GPUChanged(self, *args, **kwargs):
+        self.sigGPUChanged.emit()

tomwer/gui/utils/illustrations.py

@@ -1,35 +1,10 @@
 # coding: utf-8
-# /*##########################################################################
-# Copyright (C) 2017 European Synchrotron Radiation Facility
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#
-#############################################################################*/
 
 """
 Some utils GUI associated to illustrations
 """
 
-__authors__ = ["H.Payno"]
-__license__ = "MIT"
-__date__ = "28/09/2018"
-
+from __future__ import annotations
 
 from silx.gui import qt
 

tomwer/gui/utils/inputwidget.py

@@ -1,34 +1,7 @@
-# coding: utf-8
-# /*##########################################################################
-# Copyright (C) 2017 European Synchrotron Radiation Facility
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#
-#############################################################################*/
-
-__authors__ = ["H.Payno"]
-__license__ = "MIT"
-__date__ = "16/08/2018"
+from __future__ import annotations
 
 import logging
 import os
-from typing import Optional, Union
 
 import numpy
 from nxtomomill.io.config import TomoEDFConfig as EDFConfig
@@ -39,6 +12,7 @@ from tomoscan.identifier import BaseIdentifier
 
 from tomwer.gui import icons
 from tomwer.gui.qlefilesystem import QLFileSystem
+from tomwer.gui.utils.qt_utils import block_signals
 from tomwer.io.utils import get_default_directory
 from tomwer.core.volume.volumefactory import VolumeFactory
 from tomwer.core.process.output import ProcessDataOutputDirMode
@@ -88,7 +62,7 @@ class SelectionLineEdit(qt.QWidget):
         self._button = SelectionModeButton(parent=self)
         self.layout().addWidget(self._button)
 
-        # Qobject signal connections
+        # QObject signal connections
         self._qLineEdit.textChanged.connect(self._checkIfModeChanged)
         self._button.sigModeChanged.connect(self._modeChanged)
 
@@ -135,12 +109,11 @@ class SelectionLineEdit(qt.QWidget):
             return None
 
     def _checkIfModeChanged(self, _str):
-        self._button.blockSignals(True)
-        if _str.count(":") > 0:
-            self._button.mode = self.RANGE_MODE
-        else:
-            self._button.mode = self.LIST_MODE
-        self._button.blockSignals(False)
+        with block_signals(self._button):
+            if _str.count(":") > 0:
+                self._button.mode = self.RANGE_MODE
+            else:
+                self._button.mode = self.LIST_MODE
 
     def _modeChanged(self, mode):
         if mode == self.RANGE_MODE:
@@ -148,24 +121,24 @@ class SelectionLineEdit(qt.QWidget):
         elif mode == self.LIST_MODE:
             text = "val1; val2; ..."
         else:
-            raise ValueError("unknow mode")
+            raise ValueError("unknown mode")
 
-        self._qLineEdit.blockSignals(True)
-        self._qLineEdit.setPlaceholderText(text)
-        self._qLineEdit.blockSignals(False)
+        with block_signals(self._qLineEdit):
+            self._qLineEdit.setPlaceholderText(text)
 
 
 class SelectionModeButton(qt.QToolButton):
     """Base class for Selection QAction.
 
-    :param str mode: the mode of selection of the action.
-    :param str text: The name of this action to be used for menu label
-    :param str tooltip: The text of the tooltip
+    :param mode: the mode of selection of the action.
+    :param text: The name of this action to be used for menu label
+    :param tooltip: The text of the tooltip
     :param triggered: The callback to connect to the action's triggered
                       signal or None for no callback.
     """
 
     sigModeChanged = qt.Signal(str)
+    """signal emit when the mode is changed"""
 
     def __init__(self, parent=None, tooltip=None, triggered=None):
         qt.QToolButton.__init__(self, parent)
@@ -223,6 +196,7 @@ class SelectionAction(qt.QAction):
     """
 
     sigModeChanged = qt.Signal(str)
+    """emit when the mode change"""
 
     def __init__(self, mode, parent, text):
         icon = icons.getQIcon("_".join([mode, "selection"]))
@@ -272,7 +246,6 @@ class NXTomomillOutputDirSelector(qt.QWidget):
 
         tooltip = """Define the output directory of the nexus (.nx) file. Options are:
         \n - same folder as scan: create the NXtomos at the same level as the bliss input file or spec folder
-        \n - 'RAW_DATA' folder: create NXtomos on the default 'RAW_DATA' folder (bliss default folder, nearby the 'raw' folder).
         \n - 'PROCESSED_DATA' folder: create NXtomos on the default 'PROCESSED_DATA' folder (bliss default folder, nearby the 'raw' folder).
         \n - user defined folder: users can provide their own folders using keywords for string formatting such as 'scan_dir_name', 'scan_basename' or 'scan_parent_dir_basename'
         """
@@ -287,11 +260,6 @@ class NXTomomillOutputDirSelector(qt.QWidget):
         self._processedDataFolderRB.setToolTip(tooltip)
         self.layout().addWidget(self._processedDataFolderRB, 1, 0, 1, 1)
         self.__buttonGroup.addButton(self._processedDataFolderRB)
-        # output dir is the default 'reduced'folder
-        self._rawDataFolderRB = qt.QRadioButton("'RAW_DATA' folder", self)
-        self._rawDataFolderRB.setToolTip(tooltip)
-        self.layout().addWidget(self._rawDataFolderRB, 2, 0, 1, 1)
-        self.__buttonGroup.addButton(self._rawDataFolderRB)
         # manual
         self._manualRB = qt.QRadioButton("custom output directory", self)
         self._manualRB.setToolTip(tooltip)
@@ -311,7 +279,6 @@ class NXTomomillOutputDirSelector(qt.QWidget):
         self.__buttonGroup.buttonReleased.connect(self._updateVisiblity)
         self._inScanFolder.toggled.connect(self.sigChanged)
         self._processedDataFolderRB.toggled.connect(self.sigChanged)
-        self._rawDataFolderRB.toggled.connect(self.sigChanged)
         self._manualRB.toggled.connect(self.sigChanged)
         self._outputFolderQLE.editingFinished.connect(self.sigChanged)
 
@@ -338,38 +305,33 @@ class NXTomomillOutputDirSelector(qt.QWidget):
         self._outputFolderQLE.setText(dialog.selectedFiles()[0])
         self.sigChanged.emit()
 
-    def getOutputFolder(self) -> Union[str, ProcessDataOutputDirMode]:
+    def getOutputFolder(self) -> str | ProcessDataOutputDirMode:
         if self._manualRB.isChecked():
             return self._outputFolderQLE.text()
         elif self._processedDataFolderRB.isChecked():
             return ProcessDataOutputDirMode.PROCESSED_DATA_FOLDER
         elif self._inScanFolder.isChecked():
             return ProcessDataOutputDirMode.IN_SCAN_FOLDER
-        elif self._rawDataFolderRB.isChecked():
-            return ProcessDataOutputDirMode.RAW_DATA_FOLDER
         else:
             raise RuntimeError("Use case - h52nx output dir - not handled")
 
     def setOutputFolder(self, output_folder: str):
-        old = self.blockSignals(True)
-        self._manualRB.setChecked(output_folder is not None)
-        try:
-            default_output = ProcessDataOutputDirMode.from_value(output_folder)
-        except ValueError:
-            self._outputFolderQLE.setText(output_folder)
-            self._manualRB.setChecked(True)
-        else:
-            if default_output is ProcessDataOutputDirMode.IN_SCAN_FOLDER:
-                self._inScanFolder.setChecked(True)
-            elif default_output is ProcessDataOutputDirMode.PROCESSED_DATA_FOLDER:
-                self._processedDataFolderRB.setChecked(True)
-            elif default_output is ProcessDataOutputDirMode.RAW_DATA_FOLDER:
-                self._rawDataFolderRB.setChecked(True)
+        with block_signals(self):
+            self._manualRB.setChecked(output_folder is not None)
+            try:
+                default_output = ProcessDataOutputDirMode.from_value(output_folder)
+            except ValueError:
+                self._outputFolderQLE.setText(output_folder)
+                self._manualRB.setChecked(True)
             else:
-                raise ValueError(f"default output not handled ({default_output})")
-        finally:
-            self._updateVisiblity()
-            self.blockSignals(old)
+                if default_output is ProcessDataOutputDirMode.IN_SCAN_FOLDER:
+                    self._inScanFolder.setChecked(True)
+                elif default_output is ProcessDataOutputDirMode.PROCESSED_DATA_FOLDER:
+                    self._processedDataFolderRB.setChecked(True)
+                else:
+                    raise ValueError(f"default output not handled ({default_output})")
+            finally:
+                self._updateVisiblity()
 
 
 class _ConfigFileSelector(qt.QWidget):
@@ -381,7 +343,7 @@ class _ConfigFileSelector(qt.QWidget):
 
     def __init__(self, parent=None, try_load_cfg: bool = True):
         """
-        :param bool try_load_cfg: If True then when a file path is provided will try to load the configuration using '_load_config' and display error if the file is malformed
+        :param try_load_cfg: If True then when a file path is provided will try to load the configuration using '_load_config' and display error if the file is malformed
         """
         super().__init__(parent)
         self._try_load_cfg = try_load_cfg
@@ -517,7 +479,7 @@ class OutputVolumeDefinition(qt.QWidget):
         else:
             return self.selectOutputFolder()
 
-    def selectOutputFile(self, extensions) -> Optional[str]:
+    def selectOutputFile(self, extensions) -> str | None:
         dialog = qt.QFileDialog(self)
         dialog.setNameFilters(extensions)
         if os.environ.get("TOMWER_DEFAULT_INPUT_DIR", None) and os.path.exists(
@@ -538,7 +500,7 @@ class OutputVolumeDefinition(qt.QWidget):
         else:
             return dialog.selectedFiles()
 
-    def selectOutputFolder(self) -> Optional[str]:
+    def selectOutputFolder(self) -> str | None:
         dialog = qt.QFileDialog(self)
         dialog.setFileMode(qt.QFileDialog.DirectoryOnly)
         if os.environ.get("TOMWER_DEFAULT_INPUT_DIR", None) and os.path.exists(

tomwer/gui/utils/lineselector/lineselector.py

@@ -1,37 +1,8 @@
-# /*##########################################################################
-# Copyright (C) 20016-2017 European Synchrotron Radiation Facility
-#
-# This file is part of tomogui. Interface for tomography developed at
-# the ESRF by the Software group.
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#
-#############################################################################*/
-
-__author__ = ["H. Payno"]
-__license__ = "MIT"
-__date__ = "15/09/2017"
+from __future__ import annotations
 
 import logging
 from collections import OrderedDict
-from collections.abc import Iterable
-from typing import Optional, Union
+from typing import Iterable
 
 import numpy
 from silx.gui import qt
@@ -45,11 +16,10 @@ class QSliceSelectorDialog(qt.QDialog):
     The dialog used to select some slice indexes from a radio
 
     :param QWidget parent: parent widget
-    :param Union[int,None] n_required_slice: number of required slice we expect
-                                             the user to select
+    :param n_required_slice: number of required slice we expect the user to select
     """
 
-    def __init__(self, parent, n_required_slice=None):
+    def __init__(self, parent, n_required_slice: int | None = None):
         qt.QDialog.__init__(self, parent=parent)
         self.setLayout(qt.QVBoxLayout())
         self.setWindowTitle("select slices on radio")
@@ -73,7 +43,6 @@ class QSliceSelectorDialog(qt.QDialog):
         """
 
         :param rows: define the selection
-        :type: Iterable
         """
         if self.nRequiredSlice() is not None and len(selection) > self.nRequiredSlice():
             raise ValueError(
@@ -94,7 +63,6 @@ class QSliceSelectorDialog(qt.QDialog):
         """
 
         :return: the selection of slices to use
-        :rtype: tuple
         """
         return self.mainWidget.getSelection()
 
@@ -107,7 +75,7 @@ class QSliceSelectorDialog(qt.QDialog):
         else:
             return qt.QDialog.exec_(self)
 
-    def nRequiredSlice(self) -> Optional[int]:
+    def nRequiredSlice(self) -> int | None:
         return self.mainWidget.nRequiredSlice()
 
 
@@ -129,7 +97,7 @@ class QLineSelector(qt.QWidget):
         # connect signal / slot
         self._plot.sigPlotSignal.connect(self._plotDrawEvent)
 
-    def nRequiredSlice(self) -> Optional[int]:
+    def nRequiredSlice(self) -> int | None:
         return self._n_required_slice
 
     def setData(self, data: numpy.ndarray):
@@ -137,7 +105,6 @@ class QLineSelector(qt.QWidget):
         Define the data from which we can select slices
 
         :param data: data to plot
-        :type: numpy.ndarray
         """
         self._has_data = True
         self._plot.addImage(data)
@@ -147,7 +114,6 @@ class QLineSelector(qt.QWidget):
         """
 
         :return: the selection of slices to use
-        :rtype: tuple
         """
         res = []
         for _, marker in self.__selection.items():
@@ -167,7 +133,6 @@ class QLineSelector(qt.QWidget):
         """
 
         :param rows: define the selection
-        :type: Iterable
         """
         assert type(rows) is not str
         self._clear()
@@ -175,12 +140,11 @@ class QLineSelector(qt.QWidget):
             for row in rows:
                 self.addSlice(row)
 
-    def addSlice(self, row: Union[float, int]) -> None:
+    def addSlice(self, row: float | int) -> None:
         """
         Add the requested slice to the selection
 
         :param row:
-        :type; Union[float, int]
         """
         row_n = round(float(row))
 
@@ -210,12 +174,11 @@ class QLineSelector(qt.QWidget):
     def _getLegend(self, row_n) -> str:
         return str(round(float(row_n)))
 
-    def removeSlice(self, row: Union[float, int]) -> None:
+    def removeSlice(self, row: float | int) -> None:
         """
         remove the requested slice from the selection
 
-        :param row:
-        :type; Union[float, int]
+        :param row: row containing the slice to be removed
         """
         legend = self._getLegend(row_n=row)
         if legend in self.__selection:

tomwer/gui/utils/loadingmode.py

@@ -0,0 +1,81 @@
+from __future__ import annotations
+import functools
+from silx.utils.enum import Enum as _Enum
+from silx.gui import qt
+from tomwer.gui import icons
+
+
+class LoadingMode(_Enum):
+    ON_SHOW_LOADING = "load when show requested"
+    LAZY_LOADING = "lazy loading"
+    ASAP_LOADING = "load ASAP"
+
+    def icon(self):
+        if self is self.ON_SHOW_LOADING:
+            return icons.getQIcon("low_speed")
+        elif self is self.LAZY_LOADING:
+            return icons.getQIcon("medium_low_speed")
+        elif self is self.ASAP_LOADING:
+            return icons.getQIcon("high_speed")
+        else:
+            raise ValueError(f"loading mode {self} not handled")
+
+    def tooltip(self):
+        if self is self.ON_SHOW_LOADING:
+            return "will load data only when requiring"
+            return icons.getQIcon("medium_low_speed")
+        elif self is self.LAZY_LOADING:
+            return "load data with reduce prefetch"
+        elif self is self.ASAP_LOADING:
+            return "load data as soon as possible"
+        else:
+            raise ValueError(f"loading mode {self} not handled")
+
+
+class LoadingModeToolButton(qt.QToolButton):
+    """Tool button to switch keep aspect ratio of a plot"""
+
+    sigLoadModeChanged = qt.Signal(str)
+
+    def __init__(self, parent=None):
+        super(LoadingModeToolButton, self).__init__(parent=parent)
+        menu = qt.QMenu(self)
+
+        action_lazy_loading = LazyLoadingAction(parent=self)
+        # by default icons are not visible from the menu. In this case we want to display it
+        action_lazy_loading.setIconVisibleInMenu(True)
+        fctLL = functools.partial(self.setLoadingMode, LoadingMode.LAZY_LOADING)
+        menu.addAction(action_lazy_loading)
+
+        action_asap_loading = ASAP_LoadingAction(parent=self)
+        action_asap_loading.setIconVisibleInMenu(True)
+        fctAL = functools.partial(self.setLoadingMode, LoadingMode.ASAP_LOADING)
+        menu.addAction(action_asap_loading)
+
+        self.setMenu(menu)
+        # connect signal / slot
+        action_lazy_loading.triggered.connect(fctLL)
+        action_asap_loading.triggered.connect(fctAL)
+
+        # set up
+        self.setPopupMode(qt.QToolButton.InstantPopup)
+        self.setLoadingMode(LoadingMode.LAZY_LOADING)
+
+    def setLoadingMode(self, loadingMode: LoadingMode | str):
+        loadingMode = LoadingMode(loadingMode)
+        assert loadingMode in LoadingMode
+        self.setIcon(loadingMode.icon())
+        self.setToolTip(loadingMode.tooltip())
+        self.sigLoadModeChanged.emit(loadingMode.value)
+
+
+class LazyLoadingAction(qt.QAction):
+    def __init__(self, parent):
+        super().__init__("load data with small prefetch", parent=parent)
+        self.setIcon(LoadingMode.LAZY_LOADING.icon())
+
+
+class ASAP_LoadingAction(qt.QAction):
+    def __init__(self, parent):
+        super().__init__("load data ASAP", parent=parent)
+        self.setIcon(LoadingMode.ASAP_LOADING.icon())

tomwer/gui/utils/qt_utils.py

@@ -2,6 +2,15 @@ from contextlib import contextmanager
 
 from silx.gui import qt
 
+if qt.BINDING == "PyQt5":
+    from PyQt5.QtTest import QSignalSpy  # pylint: disable=E0401,E0611
+elif qt.BINDING == "PySide6":
+    from PySide6.QtTest import QSignalSpy  # pylint: disable=E0401,E0611
+elif qt.BINDING == "PyQt6":
+    from PyQt6.QtTest import QSignalSpy  # pylint: disable=E0401,E0611
+else:
+    QSignalSpy = None
+
 
 @contextmanager
 def block_signals(w: qt.QWidget):