bec-widgets 1.25.1__py3-none-any.whl → 2.0.1__py3-none-any.whl

bec_widgets/widgets/plots/image/image.pyproject

@@ -0,0 +1 @@
+{'files': ['image.py']}

bec_widgets/widgets/plots/image/image_item.py

@@ -0,0 +1,279 @@
+from __future__ import annotations
+
+from typing import Literal, Optional
+
+import numpy as np
+import pyqtgraph as pg
+from bec_lib.logger import bec_logger
+from pydantic import Field, ValidationError, field_validator
+from qtpy.QtCore import Signal
+
+from bec_widgets.utils import BECConnector, Colors, ConnectionConfig
+from bec_widgets.widgets.plots.image.image_processor import (
+    ImageProcessor,
+    ImageStats,
+    ProcessingConfig,
+)
+
+logger = bec_logger.logger
+
+
+# noinspection PyDataclass
+class ImageItemConfig(ConnectionConfig):  # TODO review config
+    parent_id: str | None = Field(None, description="The parent plot of the image.")
+    monitor: str | None = Field(None, description="The name of the monitor.")
+    monitor_type: Literal["1d", "2d", "auto"] = Field("auto", description="The type of monitor.")
+    source: str | None = Field(None, description="The source of the curve.")
+    color_map: str | None = Field("plasma", description="The color map of the image.")
+    downsample: bool | None = Field(True, description="Whether to downsample the image.")
+    opacity: float | None = Field(1.0, description="The opacity of the image.")
+    v_range: tuple[float | int, float | int] | None = Field(
+        None, description="The range of the color bar. If None, the range is automatically set."
+    )
+    autorange: bool | None = Field(True, description="Whether to autorange the color bar.")
+    autorange_mode: Literal["max", "mean"] = Field(
+        "mean", description="Whether to use the mean of the image for autoscaling."
+    )
+    processing: ProcessingConfig = Field(
+        default_factory=ProcessingConfig, description="The post processing of the image."
+    )
+
+    model_config: dict = {"validate_assignment": True}
+    _validate_color_map = field_validator("color_map")(Colors.validate_color_map)
+
+
+class ImageItem(BECConnector, pg.ImageItem):
+    RPC = True
+    USER_ACCESS = [
+        "color_map",
+        "color_map.setter",
+        "v_range",
+        "v_range.setter",
+        "v_min",
+        "v_min.setter",
+        "v_max",
+        "v_max.setter",
+        "autorange",
+        "autorange.setter",
+        "autorange_mode",
+        "autorange_mode.setter",
+        "fft",
+        "fft.setter",
+        "log",
+        "log.setter",
+        "rotation",
+        "rotation.setter",
+        "transpose",
+        "transpose.setter",
+        "get_data",
+    ]
+
+    vRangeChangedManually = Signal(tuple)
+
+    def __init__(
+        self,
+        config: Optional[ImageItemConfig] = None,
+        gui_id: Optional[str] = None,
+        parent_image=None,
+        **kwargs,
+    ):
+        if config is None:
+            config = ImageItemConfig(widget_class=self.__class__.__name__)
+            self.config = config
+        else:
+            self.config = config
+        if parent_image is not None:
+            self.set_parent(parent_image)
+        else:
+            self.parent_image = None
+        super().__init__(config=config, gui_id=gui_id, **kwargs)
+
+        self.raw_data = None
+        self.buffer = []
+        self.max_len = 0
+
+        # Image processor will handle any setting of data
+        self._image_processor = ImageProcessor(config=self.config.processing)
+
+    def set_parent(self, parent: BECConnector):
+        self.parent_image = parent
+
+    def parent(self):
+        return self.parent_image
+
+    def set_data(self, data: np.ndarray):
+        self.raw_data = data
+        self._process_image()
+
+    ################################################################################
+    # Properties
+    @property
+    def color_map(self) -> str:
+        """Get the current color map."""
+        return self.config.color_map
+
+    @color_map.setter
+    def color_map(self, value: str):
+        """Set a new color map."""
+        try:
+            self.config.color_map = value
+            self.setColorMap(value)
+        except ValidationError:
+            logger.error(f"Invalid colormap '{value}' provided.")
+
+    @property
+    def v_range(self) -> tuple[float, float]:
+        """
+        Get the color intensity range of the image.
+        """
+        if self.levels is not None:
+            return tuple(float(x) for x in self.levels)
+        return 0.0, 1.0
+
+    @v_range.setter
+    def v_range(self, vrange: tuple[float, float]):
+        """
+        Set the color intensity range of the image.
+        """
+        self.set_v_range(vrange, disable_autorange=True)
+
+    def set_v_range(self, vrange: tuple[float, float], disable_autorange=True):
+        if disable_autorange:
+            self.config.autorange = False
+            self.vRangeChangedManually.emit(vrange)
+        self.setLevels(vrange)
+        self.config.v_range = vrange
+
+    @property
+    def v_min(self) -> float:
+        return self.v_range[0]
+
+    @v_min.setter
+    def v_min(self, value: float):
+        self.v_range = (value, self.v_range[1])
+
+    @property
+    def v_max(self) -> float:
+        return self.v_range[1]
+
+    @v_max.setter
+    def v_max(self, value: float):
+        self.v_range = (self.v_range[0], value)
+
+    ################################################################################
+    # Autorange Logic
+
+    @property
+    def autorange(self) -> bool:
+        return self.config.autorange
+
+    @autorange.setter
+    def autorange(self, value: bool):
+        self.config.autorange = value
+        if value:
+            self.apply_autorange()
+
+    @property
+    def autorange_mode(self) -> str:
+        return self.config.autorange_mode
+
+    @autorange_mode.setter
+    def autorange_mode(self, mode: str):
+        self.config.autorange_mode = mode
+        if self.autorange:
+            self.apply_autorange()
+
+    def apply_autorange(self):
+        if self.raw_data is None:
+            return
+        data = self.image
+        if data is None:
+            data = self.raw_data
+        stats = ImageStats.from_data(data)
+        self.auto_update_vrange(stats)
+
+    def auto_update_vrange(self, stats: ImageStats) -> None:
+        """Update the v_range based on the stats of the image."""
+        fumble_factor = 2
+        if self.config.autorange_mode == "mean":
+            vmin = max(stats.mean - fumble_factor * stats.std, 0)
+            vmax = stats.mean + fumble_factor * stats.std
+        elif self.config.autorange_mode == "max":
+            vmin, vmax = stats.minimum, stats.maximum
+        else:
+            return
+        self.set_v_range(vrange=(vmin, vmax), disable_autorange=False)
+
+    ################################################################################
+    # Data Processing Logic
+
+    def _process_image(self):
+        """
+        Reprocess the current raw data and update the image display.
+        """
+        if self.raw_data is not None:
+            autorange = self.config.autorange
+            self._image_processor.set_config(self.config.processing)
+            processed_data = self._image_processor.process_image(self.raw_data)
+            self.setImage(processed_data, autoLevels=False)
+            self.autorange = autorange
+
+    @property
+    def fft(self) -> bool:
+        """Get or set whether FFT postprocessing is enabled."""
+        return self.config.processing.fft
+
+    @fft.setter
+    def fft(self, enable: bool):
+        self.config.processing.fft = enable
+        self._process_image()
+
+    @property
+    def log(self) -> bool:
+        """Get or set whether logarithmic scaling is applied."""
+        return self.config.processing.log
+
+    @log.setter
+    def log(self, enable: bool):
+        self.config.processing.log = enable
+        self._process_image()
+
+    @property
+    def num_rotation_90(self) -> Optional[int]:
+        """Get or set the number of 90° rotations to apply."""
+        return self.config.processing.num_rotation_90
+
+    @num_rotation_90.setter
+    def num_rotation_90(self, value: Optional[int]):
+        self.config.processing.num_rotation_90 = value
+        self._process_image()
+
+    @property
+    def transpose(self) -> bool:
+        """Get or set whether the image is transposed."""
+        return self.config.processing.transpose
+
+    @transpose.setter
+    def transpose(self, enable: bool):
+        self.config.processing.transpose = enable
+        self._process_image()
+
+    ################################################################################
+    # Export
+    def get_data(self) -> np.ndarray:
+        """
+        Get the data of the image.
+        Returns:
+            np.ndarray: The data of the image.
+        """
+        return self.image
+
+    def clear(self):
+        super().clear()
+        self.raw_data = None
+        self.buffer = []
+        self.max_len = 0
+
+    def remove(self):
+        self.parent().disconnect_monitor(self.config.monitor)
+        self.clear()

bec_widgets/widgets/plots/{motor_map/bec_motor_map_widget_plugin.py → image/image_plugin.py}

@@ -1,41 +1,39 @@
-import os
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
 
-import bec_widgets
 from bec_widgets.utils.bec_designer import designer_material_icon
-from bec_widgets.widgets.plots.motor_map.motor_map_widget import BECMotorMapWidget
+from bec_widgets.widgets.plots.image.image import Image
 
 DOM_XML = """
 <ui language='c++'>
-    <widget class='BECMotorMapWidget' name='bec_motor_map_widget'>
+    <widget class='Image' name='image'>
     </widget>
 </ui>
 """
 
-MODULE_PATH = os.path.dirname(bec_widgets.__file__)
 
-
-class BECMotorMapWidgetPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
+class ImagePlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
     def __init__(self):
         super().__init__()
         self._form_editor = None
 
     def createWidget(self, parent):
-        t = BECMotorMapWidget(parent)
+        t = Image(parent)
         return t
 
     def domXml(self):
         return DOM_XML
 
     def group(self):
-        return "BEC Plots"
+        return "Plot Widgets"
 
     def icon(self):
-        return designer_material_icon(BECMotorMapWidget.ICON_NAME)
+        return designer_material_icon(Image.ICON_NAME)
 
     def includeFile(self):
-        return "bec_motor_map_widget"
+        return "image"
 
     def initialize(self, form_editor):
         self._form_editor = form_editor
@@ -47,10 +45,10 @@ class BECMotorMapWidgetPlugin(QDesignerCustomWidgetInterface):  # pragma: no cov
         return self._form_editor is not None
 
     def name(self):
-        return "BECMotorMapWidget"
+        return "Image"
 
     def toolTip(self):
-        return "BECMotorMapWidget"
+        return "Image"
 
     def whatsThis(self):
         return self.toolTip()

bec_widgets/widgets/{containers/figure/plots → plots}/image/image_processor.py

@@ -1,11 +1,10 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
-from typing import Optional
 
 import numpy as np
 from pydantic import BaseModel, Field
-from qtpy.QtCore import QObject, Signal, Slot
+from qtpy.QtCore import QObject, Signal
 
 
 @dataclass
@@ -17,35 +16,51 @@ class ImageStats:
     mean: float
     std: float
 
+    @classmethod
+    def from_data(cls, data: np.ndarray) -> ImageStats:
+        """
+        Get the statistics of the image data.
 
+        Args:
+            data(np.ndarray): The image data.
+
+        Returns:
+            ImageStats: The statistics of the image data.
+        """
+        return cls(maximum=np.max(data), minimum=np.min(data), mean=np.mean(data), std=np.std(data))
+
+
+# noinspection PyDataclass
 class ProcessingConfig(BaseModel):
-    fft: Optional[bool] = Field(False, description="Whether to perform FFT on the monitor data.")
-    log: Optional[bool] = Field(False, description="Whether to perform log on the monitor data.")
-    center_of_mass: Optional[bool] = Field(
-        False, description="Whether to calculate the center of mass of the monitor data."
-    )
-    transpose: Optional[bool] = Field(
+    fft: bool = Field(False, description="Whether to perform FFT on the monitor data.")
+    log: bool = Field(False, description="Whether to perform log on the monitor data.")
+    transpose: bool = Field(
         False, description="Whether to transpose the monitor data before displaying."
     )
-    rotation: Optional[int] = Field(
-        None, description="The rotation angle of the monitor data before displaying."
+    num_rotation_90: int = Field(
+        0, description="The rotation angle of the monitor data before displaying."
     )
-    model_config: dict = {"validate_assignment": True}
     stats: ImageStats = Field(
         ImageStats(maximum=0, minimum=0, mean=0, std=0),
         description="The statistics of the image data.",
     )
 
+    model_config: dict = {"validate_assignment": True}
+
 
-class ImageProcessor:
+class ImageProcessor(QObject):
     """
     Class for processing the image data.
     """
 
-    def __init__(self, config: ProcessingConfig = None):
+    image_processed = Signal(np.ndarray)
+
+    def __init__(self, parent=None, config: ProcessingConfig = None):
+        super().__init__(parent=parent)
         if config is None:
             config = ProcessingConfig()
         self.config = config
+        self._current_thread = None
 
     def set_config(self, config: ProcessingConfig):
         """
@@ -109,9 +124,6 @@ class ImageProcessor:
         data_offset = data + offset
         return np.log10(data_offset)
 
-    # def center_of_mass(self, data: np.ndarray) -> tuple:  # TODO check functionality
-    #     return np.unravel_index(np.argmax(data), data.shape)
-
     def update_image_stats(self, data: np.ndarray) -> None:
         """Get the statistics of the image data.
 
@@ -125,59 +137,14 @@ class ImageProcessor:
         self.config.stats.std = np.std(data)
 
     def process_image(self, data: np.ndarray) -> np.ndarray:
-        """
-        Process the data according to the configuration.
-
-        Args:
-            data(np.ndarray): The data to be processed.
-
-        Returns:
-            np.ndarray: The processed data.
-        """
+        """Core processing logic without threading overhead."""
         if self.config.fft:
             data = self.FFT(data)
-        if self.config.rotation is not None:
-            data = self.rotation(data, self.config.rotation)
+        if self.config.num_rotation_90 is not None:
+            data = self.rotation(data, self.config.num_rotation_90)
         if self.config.transpose:
             data = self.transpose(data)
         if self.config.log:
             data = self.log(data)
         self.update_image_stats(data)
         return data
-
-
-class ProcessorWorker(QObject):
-    """
-    Worker for processing the image data.
-    """
-
-    processed = Signal(str, np.ndarray)
-    stats = Signal(str, ImageStats)
-    stopRequested = Signal()
-    finished = Signal()
-
-    def __init__(self, processor):
-        super().__init__()
-        self.processor = processor
-        self._isRunning = False
-        self.stopRequested.connect(self.stop)
-
-    @Slot(str, np.ndarray)
-    def process_image(self, device: str, image: np.ndarray):
-        """
-        Process the image data.
-
-        Args:
-            device(str): The name of the device.
-            image(np.ndarray): The image data.
-        """
-        self._isRunning = True
-        processed_image = self.processor.process_image(image)
-        self._isRunning = False
-        if not self._isRunning:
-            self.processed.emit(device, processed_image)
-            self.stats.emit(self.processor.config.stats)
-            self.finished.emit()
-
-    def stop(self):
-        self._isRunning = False

bec_widgets/widgets/plots/image/{register_bec_image_widget.py → register_image.py}

@@ -6,9 +6,9 @@ def main():  # pragma: no cover
         return
     from PySide6.QtDesigner import QPyDesignerCustomWidgetCollection
 
-    from bec_widgets.widgets.plots.image.bec_image_widget_plugin import BECImageWidgetPlugin
+    from bec_widgets.widgets.plots.image.image_plugin import ImagePlugin
 
-    QPyDesignerCustomWidgetCollection.addCustomWidget(BECImageWidgetPlugin())
+    QPyDesignerCustomWidgetCollection.addCustomWidget(ImagePlugin())
 
 
 if __name__ == "__main__":  # pragma: no cover

bec_widgets/widgets/plots/image/toolbar_bundles/image_selection.py

@@ -0,0 +1,59 @@
+from bec_lib.device import ReadoutPriority
+from qtpy.QtCore import Qt
+from qtpy.QtWidgets import QComboBox, QStyledItemDelegate
+
+from bec_widgets.utils.error_popups import SafeSlot
+from bec_widgets.utils.toolbar import ToolbarBundle, WidgetAction
+from bec_widgets.widgets.control.device_input.base_classes.device_input_base import BECDeviceFilter
+from bec_widgets.widgets.control.device_input.device_combobox.device_combobox import DeviceComboBox
+
+
+class NoCheckDelegate(QStyledItemDelegate):
+    """To reduce space in combo boxes by removing the checkmark."""
+
+    def initStyleOption(self, option, index):
+        super().initStyleOption(option, index)
+        # Remove any check indicator
+        option.checkState = Qt.Unchecked
+
+
+class MonitorSelectionToolbarBundle(ToolbarBundle):
+    """
+    A bundle of actions for a toolbar that controls monitor selection on a plot.
+    """
+
+    def __init__(self, bundle_id="device_selection", target_widget=None, **kwargs):
+        super().__init__(bundle_id=bundle_id, actions=[], **kwargs)
+        self.target_widget = target_widget
+
+        # 1) Device combo box
+        self.device_combo_box = DeviceComboBox(
+            parent=self.target_widget,
+            device_filter=BECDeviceFilter.DEVICE,
+            readout_priority_filter=[ReadoutPriority.ASYNC],
+        )
+        self.device_combo_box.addItem("", None)
+        self.device_combo_box.setCurrentText("")
+        self.device_combo_box.setToolTip("Select Device")
+        self.device_combo_box.setItemDelegate(NoCheckDelegate(self.device_combo_box))
+
+        self.add_action("monitor", WidgetAction(widget=self.device_combo_box, adjust_size=True))
+
+        # 2) Dimension combo box
+        self.dim_combo_box = QComboBox(parent=self.target_widget)
+        self.dim_combo_box.addItems(["auto", "1d", "2d"])
+        self.dim_combo_box.setCurrentText("auto")
+        self.dim_combo_box.setToolTip("Monitor Dimension")
+        self.dim_combo_box.setFixedWidth(60)
+        self.dim_combo_box.setItemDelegate(NoCheckDelegate(self.dim_combo_box))
+
+        self.add_action("dim_combo", WidgetAction(widget=self.dim_combo_box, adjust_size=True))
+
+        # Connect slots, a device will be connected upon change of any combobox
+        self.device_combo_box.currentTextChanged.connect(lambda: self.connect_monitor())
+        self.dim_combo_box.currentTextChanged.connect(lambda: self.connect_monitor())
+
+    @SafeSlot()
+    def connect_monitor(self):
+        dim = self.dim_combo_box.currentText()
+        self.target_widget.image(monitor=self.device_combo_box.currentText(), monitor_type=dim)

bec_widgets/widgets/plots/image/toolbar_bundles/processing.py

@@ -0,0 +1,79 @@
+from bec_widgets.utils.error_popups import SafeSlot
+from bec_widgets.utils.toolbar import MaterialIconAction, ToolbarBundle
+
+
+class ImageProcessingToolbarBundle(ToolbarBundle):
+    """
+    A bundle of actions for a toolbar that controls processing of monitor.
+    """
+
+    def __init__(self, bundle_id="mouse_interaction", target_widget=None, **kwargs):
+        super().__init__(bundle_id=bundle_id, actions=[], **kwargs)
+        self.target_widget = target_widget
+
+        self.fft = MaterialIconAction(icon_name="fft", tooltip="Toggle FFT", checkable=True)
+        self.log = MaterialIconAction(icon_name="log_scale", tooltip="Toggle Log", checkable=True)
+        self.transpose = MaterialIconAction(
+            icon_name="transform", tooltip="Transpose Image", checkable=True
+        )
+        self.right = MaterialIconAction(
+            icon_name="rotate_right", tooltip="Rotate image clockwise by 90 deg"
+        )
+        self.left = MaterialIconAction(
+            icon_name="rotate_left", tooltip="Rotate image counterclockwise by 90 deg"
+        )
+        self.reset = MaterialIconAction(icon_name="reset_settings", tooltip="Reset Image Settings")
+
+        self.add_action("fft", self.fft)
+        self.add_action("log", self.log)
+        self.add_action("transpose", self.transpose)
+        self.add_action("rotate_right", self.right)
+        self.add_action("rotate_left", self.left)
+        self.add_action("reset", self.reset)
+
+        self.fft.action.triggered.connect(self.toggle_fft)
+        self.log.action.triggered.connect(self.toggle_log)
+        self.transpose.action.triggered.connect(self.toggle_transpose)
+        self.right.action.triggered.connect(self.rotate_right)
+        self.left.action.triggered.connect(self.rotate_left)
+        self.reset.action.triggered.connect(self.reset_settings)
+
+    @SafeSlot()
+    def toggle_fft(self):
+        checked = self.fft.action.isChecked()
+        self.target_widget.fft = checked
+
+    @SafeSlot()
+    def toggle_log(self):
+        checked = self.log.action.isChecked()
+        self.target_widget.log = checked
+
+    @SafeSlot()
+    def toggle_transpose(self):
+        checked = self.transpose.action.isChecked()
+        self.target_widget.transpose = checked
+
+    @SafeSlot()
+    def rotate_right(self):
+        if self.target_widget.num_rotation_90 is None:
+            return
+        rotation = (self.target_widget.num_rotation_90 - 1) % 4
+        self.target_widget.num_rotation_90 = rotation
+
+    @SafeSlot()
+    def rotate_left(self):
+        if self.target_widget.num_rotation_90 is None:
+            return
+        rotation = (self.target_widget.num_rotation_90 + 1) % 4
+        self.target_widget.num_rotation_90 = rotation
+
+    @SafeSlot()
+    def reset_settings(self):
+        self.target_widget.fft = False
+        self.target_widget.log = False
+        self.target_widget.transpose = False
+        self.target_widget.num_rotation_90 = 0
+
+        self.fft.action.setChecked(False)
+        self.log.action.setChecked(False)
+        self.transpose.action.setChecked(False)