datalab-platform 0.0.1.dev0__py3-none-any.whl → 1.0.0__py3-none-any.whl

datalab/tests/features/common/roieditor_unit_test.py

@@ -0,0 +1,102 @@
+# Copyright (c) DataLab Platform Developers, BSD 3-Clause license, see LICENSE file.
+
+"""
+ROI editor unit test
+"""
+
+# pylint: disable=invalid-name  # Allows short reference names like x, y, ...
+# guitest: show
+
+from __future__ import annotations
+
+import numpy as np
+from guidata.qthelpers import exec_dialog, qt_app_context
+from sigima.objects import ImageROI, create_image_roi, create_signal_roi
+from sigima.tests.data import create_multigaussian_image, create_paracetamol_signal
+
+from datalab.env import execenv
+from datalab.gui.roieditor import ImageROIEditor, SignalROIEditor
+from datalab.utils import qthelpers as qth
+
+
+def test_signal_roi_editor(screenshots: bool = False) -> None:
+    """Test signal ROI editor"""
+    cls = SignalROIEditor
+    title = f"Testing {cls.__name__}"
+    obj = create_paracetamol_signal()
+    roi = create_signal_roi([36.4, 40.9], indices=False, title="Test ROI")
+    obj.roi = roi
+    with qt_app_context(exec_loop=False):
+        execenv.print(title)
+        roi_editor = cls(parent=None, obj=obj, mode="extract", size=(800, 600))
+        if screenshots:
+            roi_editor.show()
+            qth.grab_save_window(roi_editor)
+        exec_dialog(roi_editor)
+
+
+def create_image_roi_example() -> ImageROI:
+    """Create an example image ROI"""
+    roi = create_image_roi("rectangle", [720, 720, 304, 304], title="Test ROI 1")
+    roi.add_roi(create_image_roi("circle", [550, 650, 165], title="Test ROI 2"))
+    roi.add_roi(
+        create_image_roi(
+            "polygon", [225, 75, 650, 175, 625, 475, 200, 675], title="Test ROI 3"
+        )
+    )
+    return roi
+
+
+def test_image_roi_editor(screenshots: bool = False) -> None:
+    """Test image ROI editor"""
+    cls = ImageROIEditor
+    title = f"Testing {cls.__name__}"
+    obj = create_multigaussian_image()
+    obj.roi = create_image_roi_example()
+    with qt_app_context(exec_loop=False):
+        execenv.print(title)
+        for mode in ("extract", "apply"):
+            execenv.print(f"  mode={mode}")
+            roi_editor = cls(parent=None, obj=obj, mode=mode, size=(800, 600))
+            if mode == "apply":
+                # Clear the ROI
+                roi_editor.remove_all_rois()
+            if screenshots and mode == "extract":
+                roi_editor.show()
+                qth.grab_save_window(roi_editor)
+            if exec_dialog(roi_editor):
+                results = roi_editor.get_roieditor_results()
+                if results is not None:
+                    edited_roi, modified = results
+                    if mode == "extract":
+                        # Test that the single ROIs are equal
+                        # pylint: disable=use-a-generator
+                        assert all(
+                            [
+                                np.array_equal(
+                                    sroi1.get_physical_coords(obj),
+                                    sroi2.get_physical_coords(obj),
+                                )
+                                for sroi1, sroi2 in zip(
+                                    obj.roi.single_rois, edited_roi.single_rois
+                                )
+                            ]
+                        ), "Single ROIs are not equal"
+                        execenv.print("    Single ROIs indice coordinates:")
+                        for sroi in edited_roi.single_rois:
+                            execenv.print(
+                                f"      {sroi.title} ({sroi.__class__.__name__}):"
+                            )
+                            c_i = [int(val) for val in sroi.get_indices_coords(obj)]
+                            c_p = [float(val) for val in sroi.get_physical_coords(obj)]
+                            execenv.print(f"        Indices : {c_i}")
+                            execenv.print(f"        Physical: {c_p}")
+                    else:
+                        # Test the use case where the ROI is cleared
+                        assert modified, "ROI is not modified"
+                        assert edited_roi.is_empty(), "ROI is not cleared"
+
+
+if __name__ == "__main__":
+    test_signal_roi_editor(screenshots=True)
+    test_image_roi_editor(screenshots=True)

datalab/tests/features/common/save_to_dir_app_test.py

@@ -0,0 +1,163 @@
+# Copyright (c) DataLab Platform Developers, BSD 3-Clause license, see LICENSE file.
+
+"""
+Save to directory application test for screenshots:
+
+  - Create signals and images
+  - Open Save to directory dialog
+  - Take screenshots for documentation
+"""
+
+# pylint: disable=invalid-name  # Allows short reference names like x, y, ...
+# guitest: show
+
+from __future__ import annotations
+
+import warnings
+from typing import TYPE_CHECKING
+
+import guidata.config as gcfg
+import guidata.dataset as gds
+
+from datalab.env import execenv
+from datalab.gui.panel.base import SaveToDirectoryGUIParam
+from datalab.tests import datalab_test_app_context, helpers
+from datalab.tests.features.common.add_metadata_unit_test import (
+    create_test_images,
+    create_test_signals,
+)
+
+if TYPE_CHECKING:
+    from datalab.gui.main import DLMainWindow
+
+
+def __save_signals_to_directory(win: DLMainWindow, screenshot: bool = False) -> None:
+    """Save signals to directory helper function."""
+    execenv.print("Save to directory signal application test:")
+    panel = win.signalpanel
+
+    # Add test signals to the panel
+    for sig in create_test_signals():
+        panel.add_object(sig)
+
+    # Select all signals
+    panel.objview.select_objects([1, 2, 3])
+
+    # Get selected objects
+    objs = panel.objview.get_sel_objects(include_groups=True)
+    extensions = ["csv", "txt", "h5sig"]
+
+    with helpers.WorkdirRestoringTempDir() as tmpdir:
+        # Temporarily disable validation to allow creating SaveToDirectoryGUIParam
+        # with an empty directory path by default
+        old_mode = gcfg.get_validation_mode()
+        gcfg.set_validation_mode(gcfg.ValidationMode.DISABLED)
+        try:
+            # Create and configure the Save to directory dialog
+            with warnings.catch_warnings():
+                warnings.simplefilter("ignore", category=gds.DataItemValidationWarning)
+                param = SaveToDirectoryGUIParam(objs, extensions)
+
+                # Configure example save parameters
+                param.directory = "" if screenshot else tmpdir
+                param.basename = "{index:03d}_{title}"
+                param.extension = ".csv"
+                param.overwrite = False
+                param.update_preview()
+                execenv.print(f"  Preview: {param.preview}")
+                assert "s001: 001_Sine Wave.csv" in param.preview
+                execenv.print("  ✓ Save to directory parameter configured correctly")
+
+                # Edit the parameter to show the dialog
+                execenv.print("  Opening Save to directory dialog...")
+                with execenv.context(screenshot=screenshot):
+                    param.edit(
+                        parent=win, wordwrap=False, object_name="s_save_to_directory"
+                    )
+
+            # Note: We don't actually call panel.save_to_directory() here as we're just
+            # testing the dialog display for screenshots
+        finally:
+            gcfg.set_validation_mode(old_mode)
+
+    execenv.print("==> Signal application test OK")
+
+
+def __save_images_to_directory(win: DLMainWindow, screenshot: bool = False) -> None:
+    """Save images to directory helper function."""
+    execenv.print("Save to directory image test:")
+    panel = win.imagepanel
+
+    # Add test images to the panel
+    for img in create_test_images():
+        panel.add_object(img)
+
+    # Select all images
+    panel.objview.select_objects([1, 2, 3])
+
+    # Get selected objects
+    objs = panel.objview.get_sel_objects(include_groups=True)
+    extensions = ["h5ima", "tiff", "png", "jpg"]
+
+    with helpers.WorkdirRestoringTempDir() as tmpdir:
+        # Temporarily disable validation to allow creating SaveToDirectoryGUIParam
+        # with an empty directory path by default
+        old_mode = gcfg.get_validation_mode()
+        gcfg.set_validation_mode(gcfg.ValidationMode.DISABLED)
+        try:
+            # Create and configure the Save to directory dialog
+            with warnings.catch_warnings():
+                warnings.simplefilter("ignore", category=gds.DataItemValidationWarning)
+                param = SaveToDirectoryGUIParam(objs, extensions)
+
+                # Configure example save parameters
+                param.directory = "" if screenshot else tmpdir
+                param.basename = "{title}_{index:04d}"
+                param.extension = ".png"
+                param.overwrite = False
+                param.update_preview()
+                execenv.print(f"  Preview: {param.preview}")
+                assert "i001: Random Noise_0001.png" in param.preview
+                execenv.print("  ✓ Save to directory parameter configured correctly")
+
+                # Edit the parameter to show the dialog
+                execenv.print("  Opening Save to directory dialog...")
+                with execenv.context(screenshot=screenshot):
+                    param.edit(
+                        parent=win, wordwrap=False, object_name="i_save_to_directory"
+                    )
+
+            # Note: We don't actually call panel.save_to_directory() here as we're just
+            # testing the dialog display for screenshots
+        finally:
+            gcfg.set_validation_mode(old_mode)
+
+    execenv.print("==> Image application test OK")
+
+
+def test_save_to_directory_signals() -> None:
+    """Test Save to directory feature for signals."""
+    with datalab_test_app_context() as win:
+        __save_signals_to_directory(win)
+
+
+def test_save_to_directory_images() -> None:
+    """Test Save to directory feature for images."""
+    with datalab_test_app_context() as win:
+        __save_images_to_directory(win)
+
+
+def save_to_directory_screenshots():
+    """Generate save to directory screenshots."""
+    with execenv.context(unattended=True):
+        with datalab_test_app_context() as win:
+            execenv.print("Save to directory screenshots test:")
+            __save_signals_to_directory(win, screenshot=True)
+            __save_images_to_directory(win, screenshot=True)
+            execenv.print("==> All screenshot tests completed")
+
+
+if __name__ == "__main__":
+    # test_save_to_directory_signals()
+    # test_save_to_directory_images()
+    save_to_directory_screenshots()