bec-widgets 0.72.1__py3-none-any.whl → 0.73.0__py3-none-any.whl

CHANGELOG.md

@@ -1,5 +1,21 @@
 # CHANGELOG
 
+## v0.73.0 (2024-06-25)
+
+### Feature
+
+* feat: add new default scaling of image_item ([`df812ea`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/df812eaad5989f2930dde41d87491868505af946))
+
+### Test
+
+* test: add test for imageitem ([`88ecd05`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/88ecd05b95974938ef1efff40e81854baf004cb4))
+
+## v0.72.2 (2024-06-25)
+
+### Fix
+
+* fix(designer): fixed designer for pyenv and venv; closes #237 ([`e631fc1`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e631fc15d8707b73d58cb64316e115a7e43961ea))
+
 ## v0.72.1 (2024-06-24)
 
 ### Fix
@@ -137,19 +153,3 @@ in their parent process ([`ce37416`](https://gitlab.psi.ch/bec/bec_widgets/-/com
 ### Test
 
 * test: add test suite for bec_status_box and status_item ([`5d4ca81`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/5d4ca816cdedec4c88aba9eb326f85392504ea1c))
-
-### Unknown
-
-* Update file requirements.txt ([`505a5ec`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/505a5ec8334ff4422913b3a7b79d39bcb42ad535))
-
-## v0.66.1 (2024-06-20)
-
-### Fix
-
-* fix: fixed shutdown for pyside ([`2718bc6`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2718bc624731301756df524d0d5beef6cb1c1430))
-
-## v0.66.0 (2024-06-20)
-
-### Feature
-
-* feat(rpc): discover widgets automatically ([`ef25f56`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ef25f5638032f931ceb292540ada618508bb2aed))

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.72.1
+Version: 0.73.0
 Summary: BEC Widgets
 Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec_widgets/issues
 Project-URL: Homepage, https://gitlab.psi.ch/bec/bec_widgets

bec_widgets/cli/client.py

@@ -711,6 +711,7 @@ class BECImageItem(RPCBase):
             - log
             - rot
             - transpose
+            - autorange_mode
         """
 
     @rpc_call
@@ -767,6 +768,15 @@ class BECImageItem(RPCBase):
             autorange(bool): Whether to autorange the color bar.
         """
 
+    @rpc_call
+    def set_autorange_mode(self, mode: "Literal['max', 'mean']" = "mean"):
+        """
+        Set the autorange mode to scale the vrange of the color bar. Choose between min/max or mean +/- std.
+
+        Args:
+            mode(Literal["max","mean"]): Max for min/max or mean for mean +/- std.
+        """
+
     @rpc_call
     def set_color_map(self, cmap: "str" = "magma"):
         """
@@ -796,7 +806,11 @@ class BECImageItem(RPCBase):
 
     @rpc_call
     def set_vrange(
-        self, vmin: "float" = None, vmax: "float" = None, vrange: "tuple[int, int]" = None
+        self,
+        vmin: "float" = None,
+        vmax: "float" = None,
+        vrange: "tuple[float, float]" = None,
+        change_autorange: "bool" = True,
     ):
         """
         Set the range of the color bar.
@@ -931,6 +945,17 @@ class BECImageShow(RPCBase):
             name(str): The name of the image. If None, apply to all images.
         """
 
+    @rpc_call
+    def set_autorange_mode(self, mode: "Literal['max', 'mean']", name: "str" = None):
+        """
+        Set the autoscale mode of the image, that decides how the vrange of the color bar is scaled.
+        Choose betwen 'max' -> min/max of the data, 'mean' -> mean +/- fudge_factor*std of the data (fudge_factor~2).
+
+        Args:
+            mode(str): The autoscale mode of the image.
+            name(str): The name of the image. If None, apply to all images.
+        """
+
     @rpc_call
     def set_monitor(self, monitor: "str", name: "str" = None):
         """

bec_widgets/utils/bec_designer.py

@@ -1,4 +1,7 @@
+import importlib.metadata
+import json
 import os
+import site
 import sys
 import sysconfig
 from pathlib import Path
@@ -9,15 +12,55 @@ if PYSIDE6:
     from PySide6.scripts.pyside_tool import (
         _extend_path_var,
         init_virtual_env,
+        qt_tool_wrapper,
         is_pyenv_python,
         is_virtual_env,
-        qt_tool_wrapper,
         ui_tool_binary,
     )
 
 import bec_widgets
 
 
+def list_editable_packages() -> list[tuple[str, str]]:
+    """
+    List all editable packages in the environment.
+
+    Returns:
+        list[tuple[str, str]]: A list of tuples containing the package name and the path to the package.
+    """
+
+    editable_packages = set()
+
+    # Get site-packages directories
+    site_packages = site.getsitepackages()
+    if hasattr(site, "getusersitepackages"):
+        site_packages.append(site.getusersitepackages())
+
+    for dist in importlib.metadata.distributions():
+        location = dist.locate_file("").resolve()
+        is_editable = all(not str(location).startswith(site_pkg) for site_pkg in site_packages)
+
+        if is_editable:
+            editable_packages.add(str(location))
+
+    for packages in site_packages:
+        # all dist-info directories in site-packages that contain a direct_url.json file
+        dist_info_dirs = Path(packages).rglob("*.dist-info")
+        for dist_info_dir in dist_info_dirs:
+            direct_url = dist_info_dir / "direct_url.json"
+            if not direct_url.exists():
+                continue
+            # load the json file and get the path to the package
+            with open(direct_url, "r", encoding="utf-8") as f:
+                data = json.load(f)
+                path = data.get("url", "")
+                if path.startswith("file://"):
+                    path = path[7:]
+                    editable_packages.add(path)
+
+    return editable_packages
+
+
 def patch_designer():  # pragma: no cover
     if not PYSIDE6:
         print("PYSIDE6 is not available in the environment. Cannot patch designer.")
@@ -40,6 +83,12 @@ def patch_designer():  # pragma: no cover
         library_name = f"libpython{major_version}.{minor_version}.dylib"
         lib_path = str(Path(sysconfig.get_config_var("LIBDIR")) / library_name)
         os.environ["DYLD_INSERT_LIBRARIES"] = lib_path
+
+        if is_pyenv_python() or is_virtual_env():
+            # append all editable packages to the PYTHONPATH
+            editable_packages = list_editable_packages()
+            for pckg in editable_packages:
+                _extend_path_var("PYTHONPATH", pckg, True)
     elif sys.platform == "win32":
         if is_virtual_env():
             _extend_path_var("PATH", os.fspath(Path(sys._base_executable).parent), True)

bec_widgets/widgets/figure/plots/image/image.py

@@ -12,7 +12,11 @@ from qtpy.QtWidgets import QWidget
 
 from bec_widgets.utils import EntryValidator
 from bec_widgets.widgets.figure.plots.image.image_item import BECImageItem, ImageItemConfig
-from bec_widgets.widgets.figure.plots.image.image_processor import ImageProcessor, ProcessorWorker
+from bec_widgets.widgets.figure.plots.image.image_processor import (
+    ImageProcessor,
+    ImageStats,
+    ProcessorWorker,
+)
 from bec_widgets.widgets.figure.plots.plot_base import BECPlotBase, SubplotConfig
 
 
@@ -35,6 +39,7 @@ class BECImageShow(BECPlotBase):
         "set_vrange",
         "set_color_map",
         "set_autorange",
+        "set_autorange_mode",
         "set_monitor",
         "set_processing",
         "set_image_properties",
@@ -86,6 +91,7 @@ class BECImageShow(BECPlotBase):
         # Connect signals and slots
         thread.started.connect(lambda: worker.process_image(device, image))
         worker.processed.connect(self.update_image)
+        worker.stats.connect(self.update_vrange)
         worker.finished.connect(thread.quit)
         worker.finished.connect(thread.wait)
         worker.finished.connect(worker.deleteLater)
@@ -341,6 +347,17 @@ class BECImageShow(BECPlotBase):
         """
         self.apply_setting_to_images("set_autorange", args=[enable], kwargs={}, image_id=name)
 
+    def set_autorange_mode(self, mode: Literal["max", "mean"], name: str = None):
+        """
+        Set the autoscale mode of the image, that decides how the vrange of the color bar is scaled.
+        Choose betwen 'max' -> min/max of the data, 'mean' -> mean +/- fudge_factor*std of the data (fudge_factor~2).
+
+        Args:
+            mode(str): The autoscale mode of the image.
+            name(str): The name of the image. If None, apply to all images.
+        """
+        self.apply_setting_to_images("set_autorange_mode", args=[mode], kwargs={}, image_id=name)
+
     def set_monitor(self, monitor: str, name: str = None):
         """
         Set the monitor of the image.
@@ -461,6 +478,7 @@ class BECImageShow(BECPlotBase):
         else:
             data = self.processor.process_image(data)
             self.update_image(device, data)
+            self.update_vrange(device, self.processor.config.stats)
 
     @pyqtSlot(str, np.ndarray)
     def update_image(self, device: str, data: np.ndarray):
@@ -474,6 +492,18 @@ class BECImageShow(BECPlotBase):
         image_to_update = self._images["device_monitor"][device]
         image_to_update.updateImage(data, autoLevels=image_to_update.config.autorange)
 
+    @pyqtSlot(str, ImageStats)
+    def update_vrange(self, device: str, stats: ImageStats):
+        """
+        Update the scaling of the image.
+
+        Args:
+            stats(ImageStats): The statistics of the image.
+        """
+        image_to_update = self._images["device_monitor"][device]
+        if image_to_update.config.autorange:
+            image_to_update.auto_update_vrange(stats)
+
     def _connect_device_monitor(self, monitor: str):
         """
         Connect to the device monitor.

bec_widgets/widgets/figure/plots/image/image_item.py

@@ -7,7 +7,7 @@ import pyqtgraph as pg
 from pydantic import Field
 
 from bec_widgets.utils import BECConnector, ConnectionConfig
-from bec_widgets.widgets.figure.plots.image.image_processor import ProcessingConfig
+from bec_widgets.widgets.figure.plots.image.image_processor import ImageStats, ProcessingConfig
 
 if TYPE_CHECKING:
     from bec_widgets.widgets.figure.plots.image.image import BECImageShow
@@ -20,13 +20,16 @@ class ImageItemConfig(ConnectionConfig):
     color_map: Optional[str] = Field("magma", description="The color map of the image.")
     downsample: Optional[bool] = Field(True, description="Whether to downsample the image.")
     opacity: Optional[float] = Field(1.0, description="The opacity of the image.")
-    vrange: Optional[tuple[int, int]] = Field(
+    vrange: Optional[tuple[float, float]] = Field(
         None, description="The range of the color bar. If None, the range is automatically set."
     )
     color_bar: Optional[Literal["simple", "full"]] = Field(
         "simple", description="The type of the color bar."
     )
     autorange: Optional[bool] = Field(True, description="Whether to autorange the color bar.")
+    autorange_mode: Optional[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."
     )
@@ -43,6 +46,7 @@ class BECImageItem(BECConnector, pg.ImageItem):
         "set_transpose",
         "set_opacity",
         "set_autorange",
+        "set_autorange_mode",
         "set_color_map",
         "set_auto_downsample",
         "set_monitor",
@@ -101,6 +105,7 @@ class BECImageItem(BECConnector, pg.ImageItem):
             - log
             - rot
             - transpose
+            - autorange_mode
         """
         method_map = {
             "downsample": self.set_auto_downsample,
@@ -112,6 +117,7 @@ class BECImageItem(BECConnector, pg.ImageItem):
             "log": self.set_log,
             "rot": self.set_rotation,
             "transpose": self.set_transpose,
+            "autorange_mode": self.set_autorange_mode,
         }
         for key, value in kwargs.items():
             if key in method_map:
@@ -175,9 +181,18 @@ class BECImageItem(BECConnector, pg.ImageItem):
             autorange(bool): Whether to autorange the color bar.
         """
         self.config.autorange = autorange
-        if self.color_bar is not None:
+        if self.color_bar and autorange:
             self.color_bar.autoHistogramRange()
 
+    def set_autorange_mode(self, mode: Literal["max", "mean"] = "mean"):
+        """
+        Set the autorange mode to scale the vrange of the color bar. Choose between min/max or mean +/- std.
+
+        Args:
+            mode(Literal["max","mean"]): Max for min/max or mean for mean +/- std.
+        """
+        self.config.autorange_mode = mode
+
     def set_color_map(self, cmap: str = "magma"):
         """
         Set the color map of the image.
@@ -212,7 +227,29 @@ class BECImageItem(BECConnector, pg.ImageItem):
         """
         self.config.monitor = monitor
 
-    def set_vrange(self, vmin: float = None, vmax: float = None, vrange: tuple[int, int] = None):
+    def auto_update_vrange(self, stats: ImageStats) -> None:
+        """Auto update of the vrange base on the stats of the image.
+
+        Args:
+            stats(ImageStats): 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
+            self.set_vrange(vmin, vmax, change_autorange=False)
+            return
+        if self.config.autorange_mode == "max":
+            self.set_vrange(max(stats.minimum, 0), stats.maximum, change_autorange=False)
+            return
+
+    def set_vrange(
+        self,
+        vmin: float = None,
+        vmax: float = None,
+        vrange: tuple[float, float] = None,
+        change_autorange: bool = True,
+    ):
         """
         Set the range of the color bar.
 
@@ -224,11 +261,13 @@ class BECImageItem(BECConnector, pg.ImageItem):
             vmin, vmax = vrange
         self.setLevels([vmin, vmax])
         self.config.vrange = (vmin, vmax)
-        self.config.autorange = False
+        if change_autorange:
+            self.config.autorange = False
         if self.color_bar is not None:
             if self.config.color_bar == "simple":
                 self.color_bar.setLevels(low=vmin, high=vmax)
             elif self.config.color_bar == "full":
+                # pylint: disable=unexpected-keyword-arg
                 self.color_bar.setLevels(min=vmin, max=vmax)
                 self.color_bar.setHistogramRange(vmin - 0.1 * vmin, vmax + 0.1 * vmax)
 

bec_widgets/widgets/figure/plots/image/image_processor.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+from dataclasses import dataclass
 from typing import Optional
 
 import numpy as np
@@ -7,6 +8,16 @@ from pydantic import BaseModel, Field
 from qtpy.QtCore import QObject, Signal, Slot
 
 
+@dataclass
+class ImageStats:
+    """Container to store stats of an image."""
+
+    maximum: float
+    minimum: float
+    mean: float
+    std: float
+
+
 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.")
@@ -20,6 +31,10 @@ class ProcessingConfig(BaseModel):
         None, 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.",
+    )
 
 
 class ImageProcessor:
@@ -97,6 +112,18 @@ class ImageProcessor:
     # 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.
+
+        Args:
+            data(np.ndarray): The image data.
+
+        """
+        self.config.stats.maximum = np.max(data)
+        self.config.stats.minimum = np.min(data)
+        self.config.stats.mean = np.mean(data)
+        self.config.stats.std = np.std(data)
+
     def process_image(self, data: np.ndarray) -> np.ndarray:
         """
         Process the data according to the configuration.
@@ -115,6 +142,7 @@ class ImageProcessor:
             data = self.transpose(data)
         if self.config.log:
             data = self.log(data)
+        self.update_image_stats(data)
         return data
 
 
@@ -124,6 +152,7 @@ class ProcessorWorker(QObject):
     """
 
     processed = Signal(str, np.ndarray)
+    stats = Signal(str, ImageStats)
     stopRequested = Signal()
     finished = Signal()
 
@@ -147,6 +176,7 @@ class ProcessorWorker(QObject):
         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):

{bec_widgets-0.72.1.dist-info → bec_widgets-0.73.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.72.1
+Version: 0.73.0
 Summary: BEC Widgets
 Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec_widgets/issues
 Project-URL: Homepage, https://gitlab.psi.ch/bec/bec_widgets

{bec_widgets-0.72.1.dist-info → bec_widgets-0.73.0.dist-info}/RECORD

@@ -2,11 +2,11 @@
 .gitlab-ci.yml,sha256=RnYDz4zKXjlqltTryprlB1s5vLXxI2-seW-Vb70NNF0,8162
 .pylintrc,sha256=OstrgmEyP0smNFBKoIN5_26-UmNZgMHnbjvAWX0UrLs,18535
 .readthedocs.yaml,sha256=aSOc277LqXcsTI6lgvm_JY80lMlr69GbPKgivua2cS0,603
-CHANGELOG.md,sha256=eHyBoADzbbpQThtx4Ywy0qQu93GH7jzX0eUUJy0RRzA,7436
+CHANGELOG.md,sha256=ASQWccB46kB7TWP7qISIQCOrxP2-NhIzE87fyan10xs,7466
 LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-PKG-INFO,sha256=a90k8syu1mPZ4wpjIW825ULD4vCl95ZzY53r_M6cPJQ,1302
+PKG-INFO,sha256=naAwZRYeVxYn6qmLeqPUjRxSzQ07BCmfxE55V5m3lYs,1302
 README.md,sha256=y4jB6wvArS7N8_iTbKWnSM_oRAqLA2GqgzUR-FMh5sU,2645
-pyproject.toml,sha256=hmU4NawNbuIpaWkx3FB55zWk3drnSyNXWE7aKRNqiTs,2215
+pyproject.toml,sha256=CKV9AeTuofbkm8y4AWqXfsmgYhaT9PYRDftimPF1QGQ,2215
 .git_hooks/pre-commit,sha256=n3RofIZHJl8zfJJIUomcMyYGFi_rwq4CC19z0snz3FI,286
 .gitlab/issue_templates/bug_report_template.md,sha256=gAuyEwl7XlnebBrkiJ9AqffSNOywmr8vygUFWKTuQeI,386
 .gitlab/issue_templates/documentation_update_template.md,sha256=FHLdb3TS_D9aL4CYZCjyXSulbaW5mrN2CmwTaeLPbNw,860
@@ -17,7 +17,7 @@ bec_widgets/assets/bec_widgets_icon.png,sha256=K8dgGwIjalDh9PRHUsSQBqgdX7a00nM3i
 bec_widgets/assets/terminal_icon.png,sha256=bJl7Tft4Fi2uxvuXI8o14uMHnI9eAWKSU2uftXCH9ws,3889
 bec_widgets/cli/__init__.py,sha256=d0Q6Fn44e7wFfLabDOBxpcJ1DPKWlFunGYDUBmO-4hA,22
 bec_widgets/cli/auto_updates.py,sha256=DyBV3HnjMSH-cvVkYNcDiYKVf0Xut4Qy2qGQqkW47Bw,4833
-bec_widgets/cli/client.py,sha256=IGtxHvLP6zkvzIEVloX9ygKRvrplNhXGmqQN-BnYlQE,58447
+bec_widgets/cli/client.py,sha256=faWHDMG9mwD1fB5ptuZ-_QWka0Lrv9iJ94QupwmqCmY,59358
 bec_widgets/cli/client_utils.py,sha256=tJwENsYTdWd4BKuoQ8fEkfp2JTuJqLJUImzRekd-Kos,12376
 bec_widgets/cli/generate_cli.py,sha256=InKBVYM7DRfAVLNJhRJbWWSSPBQBHI8Ek6v7NCsK0ME,4997
 bec_widgets/cli/rpc_register.py,sha256=QxXUZu5XNg00Yf5O3UHWOXg3-f_pzKjjoZYMOa-MOJc,2216
@@ -39,7 +39,7 @@ bec_widgets/examples/plugin_example_pyside/tictactoeplugin.py,sha256=BBt3MD8oDLU
 bec_widgets/examples/plugin_example_pyside/tictactoetaskmenu.py,sha256=LNwplI6deUdKY6FOhUuWBanotxk9asF2G-6k7lFfA8Y,2301
 bec_widgets/utils/__init__.py,sha256=1930ji1Jj6dVuY81Wd2kYBhHYNV-2R0bN_L4o9zBj1U,533
 bec_widgets/utils/bec_connector.py,sha256=3BNkb83HZDNL_fwbvMnG6FM28VTmlsndnc4z84E3v1w,7286
-bec_widgets/utils/bec_designer.py,sha256=gaxNuxRu-3rQylUd5lGSysK1lqoRg8gtmfad0CnsUPU,2613
+bec_widgets/utils/bec_designer.py,sha256=2ay6c7dLozV06vsJcceoMRe78ePxQf_7pxnrEZjOrB8,4386
 bec_widgets/utils/bec_dispatcher.py,sha256=yM9PG04O7ABhiA9Nzk38Rv9Qbjc5O93wi2xfSbOlOxc,6202
 bec_widgets/utils/bec_table.py,sha256=nA2b8ukSeUfquFMAxGrUVOqdrzMoDYD6O_4EYbOG2zk,717
 bec_widgets/utils/colors.py,sha256=GYSDe0ZxsJSwxvuy-yG2BH17qlf_Sjq8dhDcyp9IhBI,8532
@@ -83,9 +83,9 @@ bec_widgets/widgets/figure/figure.py,sha256=3bf1TyzIE8kVRDgjLqdlvCoE4wrozyfbeCWL
 bec_widgets/widgets/figure/plots/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/figure/plots/plot_base.py,sha256=QdDMMuWwTK0f6kNN8aAPBM7jah7TpUbYrMrRTdb2EZY,10419
 bec_widgets/widgets/figure/plots/image/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bec_widgets/widgets/figure/plots/image/image.py,sha256=-rxCt1IXmS2XQu0dS0SSXAF8VaxacSmQ-_kDsFxbPm4,19653
-bec_widgets/widgets/figure/plots/image/image_item.py,sha256=1oytCY2IIgRbtS3GRrp9JV02KOif78O2-iaK0qYuHFU,9058
-bec_widgets/widgets/figure/plots/image/image_processor.py,sha256=TOnHbdq9rK5--L5JNshILLm_e5_LVwuQ2-MFV8JKL9I,4423
+bec_widgets/widgets/figure/plots/image/image.py,sha256=1tZADgGQXDrFHS9CYsHD2r9KzszjHn9f2kuNqLfuwWI,20797
+bec_widgets/widgets/figure/plots/image/image_item.py,sha256=Wnq6N6q4QwGHdZzZ_ibYzqoJk68FKU6WUCcYpINhZMU,10513
+bec_widgets/widgets/figure/plots/image/image_processor.py,sha256=GeTtWjbldy6VejMwPGQgM-o3d6bmLglCjdoktu19xfA,5262
 bec_widgets/widgets/figure/plots/motor_map/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/figure/plots/motor_map/motor_map.py,sha256=Ff2WoNHxO_A3ggsbSd_AVUP1JeOWMuJs-0GLskxn-94,15267
 bec_widgets/widgets/figure/plots/waveform/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -182,6 +182,7 @@ tests/unit_tests/test_bec_connector.py,sha256=zGDfNHwLFZTbpyX6-yc7Pwzr2jWO_HGZ8T
 tests/unit_tests/test_bec_dispatcher.py,sha256=rYPiRizHaswhGZw55IBMneDFxmPiCCLAZQBqjEkpdyY,3992
 tests/unit_tests/test_bec_dock.py,sha256=BXKXpuyIYj-l6KSyhQtM_p3kRFCRECIoXLzvkcJZDlM,3611
 tests/unit_tests/test_bec_figure.py,sha256=aEd2R8K6fU2ON8QvPemGWpql_LaaYLipRlvnjBY2qFA,8009
+tests/unit_tests/test_bec_image.py,sha256=mjvcrHgOF_FCj6WbUyxvZH9HL63QGA5C0PNZ5dXYn50,2541
 tests/unit_tests/test_bec_motor_map.py,sha256=AfD_9-x6VV3TPnkQgNfFYRndPHDsGx-a_YknFeDr6hc,4588
 tests/unit_tests/test_bec_status_box.py,sha256=xR8c-hXFI9gKpNGhnnC5l_nzazfvPkWkhcAfJ77hxqY,4731
 tests/unit_tests/test_client_utils.py,sha256=eViJ1Tz-HX9TkMvQH6W8cO-c3_1I8bUc4_Yen6LOc0E,830
@@ -210,8 +211,8 @@ tests/unit_tests/test_configs/config_device_no_entry.yaml,sha256=hdvue9KLc_kfNzG
 tests/unit_tests/test_configs/config_scan.yaml,sha256=vo484BbWOjA_e-h6bTjSV9k7QaQHrlAvx-z8wtY-P4E,1915
 tests/unit_tests/test_msgs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/unit_tests/test_msgs/available_scans_message.py,sha256=m_z97hIrjHXXMa2Ex-UvsPmTxOYXfjxyJaGkIY6StTY,46532
-bec_widgets-0.72.1.dist-info/METADATA,sha256=a90k8syu1mPZ4wpjIW825ULD4vCl95ZzY53r_M6cPJQ,1302
-bec_widgets-0.72.1.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-bec_widgets-0.72.1.dist-info/entry_points.txt,sha256=3otEkCdDB9LZJuBLzG4pFLK5Di0CVybN_12IsZrQ-58,166
-bec_widgets-0.72.1.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-bec_widgets-0.72.1.dist-info/RECORD,,
+bec_widgets-0.73.0.dist-info/METADATA,sha256=naAwZRYeVxYn6qmLeqPUjRxSzQ07BCmfxE55V5m3lYs,1302
+bec_widgets-0.73.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+bec_widgets-0.73.0.dist-info/entry_points.txt,sha256=3otEkCdDB9LZJuBLzG4pFLK5Di0CVybN_12IsZrQ-58,166
+bec_widgets-0.73.0.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
+bec_widgets-0.73.0.dist-info/RECORD,,

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_widgets"
-version = "0.72.1"
+version = "0.73.0"
 description = "BEC Widgets"
 requires-python = ">=3.10"
 classifiers = [

tests/unit_tests/test_bec_image.py

@@ -0,0 +1,65 @@
+# pylint: disable=missing-function-docstring, missing-module-docstring, unused-import
+from unittest import mock
+
+import numpy as np
+import pytest
+from bec_lib import messages
+from qtpy.QtGui import QFontInfo
+
+from .client_mocks import mocked_client
+from .test_bec_figure import bec_figure
+
+
+@pytest.fixture
+def bec_image_show(bec_figure):
+    yield bec_figure.image("eiger")
+
+
+def test_on_image_update(bec_image_show):
+    data = np.random.rand(100, 100)
+    msg = messages.DeviceMonitorMessage(
+        device="eiger", data=data, metadata={"scan_id": "12345"}
+    ).model_dump()
+    bec_image_show.on_image_update(msg)
+    img = bec_image_show.images[0]
+    assert np.array_equal(img.get_data(), data)
+
+
+def test_autorange_on_image_update(bec_image_show):
+    # Check if autorange mode "mean" works, should be default
+    data = np.random.rand(100, 100)
+    msg = messages.DeviceMonitorMessage(
+        device="eiger", data=data, metadata={"scan_id": "12345"}
+    ).model_dump()
+    bec_image_show.on_image_update(msg)
+    img = bec_image_show.images[0]
+    assert np.array_equal(img.get_data(), data)
+    vmin = max(np.mean(data) - 2 * np.std(data), 0)
+    vmax = np.mean(data) + 2 * np.std(data)
+    assert np.isclose(img.color_bar.getLevels(), (vmin, vmax), rtol=(1e-5, 1e-5)).all()
+    # Test general update with autorange True, mode "max"
+    bec_image_show.set_autorange_mode("max")
+    bec_image_show.on_image_update(msg)
+    img = bec_image_show.images[0]
+    vmin = np.min(data)
+    vmax = np.max(data)
+    assert np.array_equal(img.get_data(), data)
+    assert np.isclose(img.color_bar.getLevels(), (vmin, vmax), rtol=(1e-5, 1e-5)).all()
+    # Change the input data, and switch to autorange False, colormap levels should stay untouched
+    data *= 100
+    msg = messages.DeviceMonitorMessage(
+        device="eiger", data=data, metadata={"scan_id": "12345"}
+    ).model_dump()
+    bec_image_show.set_autorange(False)
+    bec_image_show.on_image_update(msg)
+    img = bec_image_show.images[0]
+    assert np.array_equal(img.get_data(), data)
+    assert np.isclose(img.color_bar.getLevels(), (vmin, vmax), rtol=(1e-3, 1e-3)).all()
+    # Reactivate autorange, should now scale the new data
+    bec_image_show.set_autorange(True)
+    bec_image_show.set_autorange_mode("mean")
+    bec_image_show.on_image_update(msg)
+    img = bec_image_show.images[0]
+    vmin = max(np.mean(data) - 2 * np.std(data), 0)
+    vmax = np.mean(data) + 2 * np.std(data)
+    assert np.isclose(img.color_bar.getLevels(), (vmin, vmax), rtol=(1e-5, 1e-5)).all()