fix: Fix checking if channel requested by MeasurementProfile exists (#1165)

fix PARTSEG-VA

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

## Summary by CodeRabbit

- **New Features**
- Introduced a method to check the existence of channels, enhancing
validation during measurements.
- Updated handling of channel identifiers to accept both `Channel`
objects and strings for improved flexibility.
- Improved dialog functionality by allowing it to have a parent widget
for better user experience.
- Enhanced the measurement profile structure for clarity and
functionality, focusing on ROI measurements.

- **Bug Fixes**
- Enhanced error messaging for channel validity to align with user
input, improving usability.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Author: Czaki

package/PartSeg/_roi_analysis/advanced_window.py

@@ -805,7 +805,7 @@ def import_measurement_profiles(self):
             if err:
                 QMessageBox.warning(self, "Import error", "error during importing, part of data were filtered.")
             measurement_dict = self.settings.measurement_profiles
-            imp = ImportDialog(stat, measurement_dict, StringViewer, MeasurementProfile)
+            imp = ImportDialog(stat, measurement_dict, StringViewer, MeasurementProfile, parent=self)
             if not imp.exec_():
                 return
             for original_name, final_name in imp.get_import_list():

package/PartSeg/_roi_analysis/measurement_widget.py

@@ -367,11 +367,11 @@ def append_measurement_result(self):
         units = self.units_choose.currentEnum()
 
         for num in compute_class.get_channels_num():
-            if num >= self.settings.image.channels:
+            if not self.settings.image.has_channel(num):
                 QMessageBox.warning(
                     self,
                     "Measurement error",
-                    f"Cannot calculate this measurement because image do not have channel {num+1}",
+                    f"Cannot calculate this measurement because image do not have channel {num}",
                 )
                 return
 

package/PartSeg/common_gui/napari_image_view.py

@@ -413,7 +413,7 @@ def mask_opacity(self) -> float:
     def mask_color(self) -> ColorInfo:
         """Get mask marking color"""
         color = Color(np.divide(self.settings.get_from_profile("mask_presentation_color", [255, 255, 255]), 255))
-        return {0: (0, 0, 0, 0), 1: color.rgba}
+        return {0: (0, 0, 0, 0), 1: color.rgba, None: (0, 0, 0, 0)}
 
     def get_image(self, image: Optional[Image]) -> Image:
         if image is not None:

package/PartSeg/plugins/napari_widgets/measurement_widget.py

@@ -14,6 +14,7 @@
 from PartSeg.plugins.napari_widgets._settings import get_settings
 from PartSeg.plugins.napari_widgets.utils import NapariFormDialog, generate_image
 from PartSegCore.roi_info import ROIInfo
+from PartSegImage import Channel
 
 if TYPE_CHECKING:
     from PartSegCore.analysis.measurement_calculation import MeasurementProfile, MeasurementResult
@@ -58,11 +59,13 @@ def append_measurement_result(self):
         if self.channels_chose.value is None:
             return
         for name in compute_class.get_channels_num():
-            if name not in self.napari_viewer.layers:
+            if name.value not in self.napari_viewer.layers:
                 show_info(f"Cannot calculate this measurement because image do not have layer {name}")
                 return
         units = self.units_choose.currentEnum()
-        image = generate_image(self.napari_viewer, self.channels_chose.value.name, *compute_class.get_channels_num())
+        image = generate_image(
+            self.napari_viewer, Channel(self.channels_chose.value.name), *compute_class.get_channels_num()
+        )
         if self.mask_chose.value is not None:
             image.set_mask(self.mask_chose.value.data)
         roi_info = ROIInfo(self.roi_chose.value.data).fit_to_image(image)

package/PartSeg/plugins/napari_widgets/utils.py

@@ -61,8 +61,10 @@ def __init__(self, *args, **kwargs):
 def generate_image(viewer: Viewer, *layer_names):
     axis_order = Image.axis_order.replace("C", "")
     image_list = []
+    if isinstance(layer_names[0], str):
+        layer_names = [Channel(el) for el in layer_names]
     for name in dict.fromkeys(layer_names):
-        image_layer = viewer.layers[name]
+        image_layer = viewer.layers[name.value]
         data_scale = image_layer.scale[-3:] / UNIT_SCALE[Units.nm.value]
         image_list.append(
             Image(

package/PartSegCore/analysis/measurement_base.py

@@ -395,7 +395,13 @@ def calculate_property(
 
     @classmethod
     def get_starting_leaf(cls) -> Leaf:
-        """This leaf is put on default list"""
+        """This leaf is put on a default list"""
+        if (
+            hasattr(cls, "__argument_class__")
+            and cls.__argument_class__ is not None
+            and cls.__argument_class__ is not BaseModel
+        ):
+            return Leaf(name=cls._display_name(), parameters=cls.__argument_class__())
         return Leaf(name=cls._display_name())
 
     @classmethod

package/PartSegImage/image.py

@@ -526,8 +526,11 @@ def get_data_by_axis(self, **kwargs) -> np.ndarray:
         axis_pos = self.get_array_axis_positions()
         if "c" in kwargs:
             kwargs["C"] = kwargs.pop("c")
-        if "C" in kwargs and isinstance(kwargs["C"], str):
-            kwargs["C"] = self.channel_names.index(kwargs["C"])
+        if "C" in kwargs:
+            if isinstance(kwargs["C"], Channel):
+                kwargs["C"] = kwargs["C"].value
+            if isinstance(kwargs["C"], str):
+                kwargs["C"] = self.channel_names.index(kwargs["C"])
 
         channel = kwargs.pop("C", slice(None) if "C" in self.axis_order else 0)
         if isinstance(channel, Channel):
@@ -571,6 +574,14 @@ def get_channel(self, num: int | str | Channel) -> np.ndarray:
         """
         return self.get_data_by_axis(c=num)
 
+    def has_channel(self, num: int | str | Channel) -> bool:
+        if isinstance(num, Channel):
+            num = num.value
+
+        if isinstance(num, str):
+            return num in self.channel_names
+        return 0 <= num < self.channels
+
     def get_layer(self, time: int, stack: int) -> np.ndarray:
         """
         return single layer contains data for all channel

package/tests/conftest.py

@@ -12,7 +12,12 @@
 from PartSegCore.algorithm_describe_base import ROIExtractionProfile
 from PartSegCore.analysis import ProjectTuple, SegmentationPipeline, SegmentationPipelineElement
 from PartSegCore.analysis.measurement_base import AreaType, MeasurementEntry, PerComponent
-from PartSegCore.analysis.measurement_calculation import ComponentsNumber, MeasurementProfile, Volume
+from PartSegCore.analysis.measurement_calculation import (
+    ColocalizationMeasurement,
+    ComponentsNumber,
+    MeasurementProfile,
+    Volume,
+)
 from PartSegCore.image_operations import RadiusType
 from PartSegCore.mask.io_functions import MaskProjectTuple
 from PartSegCore.mask_create import MaskProperty
@@ -69,15 +74,15 @@ def image2d(tmp_path):
 
 @pytest.fixture()
 def stack_image():
-    data = np.zeros([20, 40, 40], dtype=np.uint8)
+    data = np.zeros([20, 40, 40, 2], dtype=np.uint8)
     for x, y in itertools.product([0, 20], repeat=2):
         data[1:-1, x + 2 : x + 18, y + 2 : y + 18] = 100
     for x, y in itertools.product([0, 20], repeat=2):
         data[3:-3, x + 4 : x + 16, y + 4 : y + 16] = 120
     for x, y in itertools.product([0, 20], repeat=2):
         data[5:-5, x + 6 : x + 14, y + 6 : y + 14] = 140
 
-    return MaskProjectTuple("test_path", Image(data, (2, 1, 1), axes_order="ZYX", file_path="test_path"))
+    return MaskProjectTuple("test_path", Image(data, (2, 1, 1), axes_order="ZYXC", file_path="test_path"))
 
 
 @pytest.fixture()
@@ -201,8 +206,18 @@ def measurement_profiles():
             calculation_tree=Volume.get_starting_leaf().replace_(area=AreaType.Mask, per_component=PerComponent.No),
         ),
     ]
-    return MeasurementProfile(name="statistic1", chosen_fields=statistics), MeasurementProfile(
-        name="statistic2", chosen_fields=statistics + statistics2
+    statistics3 = [
+        MeasurementEntry(
+            name="Colocalisation",
+            calculation_tree=ColocalizationMeasurement.get_starting_leaf().replace_(
+                per_component=PerComponent.No, area=AreaType.ROI
+            ),
+        ),
+    ]
+    return (
+        MeasurementProfile(name="statistic1", chosen_fields=statistics),
+        MeasurementProfile(name="statistic2", chosen_fields=statistics + statistics2),
+        MeasurementProfile(name="statistic3", chosen_fields=statistics + statistics2 + statistics3),
     )
 
 

package/tests/test_PartSeg/conftest.py

@@ -12,14 +12,14 @@
 
 
 @pytest.fixture()
-def base_settings(image, tmp_path, measurement_profiles, qapp):
+def base_settings(image, tmp_path, measurement_profiles):
     settings = BaseSettings(tmp_path)
     settings.image = image
     return settings
 
 
 @pytest.fixture()
-def part_settings(image, tmp_path, measurement_profiles, qapp):
+def part_settings(image, tmp_path, measurement_profiles):
     settings = PartSettings(tmp_path)
     settings.image = image
     for el in measurement_profiles:
@@ -28,7 +28,7 @@ def part_settings(image, tmp_path, measurement_profiles, qapp):
 
 
 @pytest.fixture()
-def stack_settings(tmp_path, image, qapp):
+def stack_settings(tmp_path, image):
     settings = StackSettings(tmp_path)
     settings.image = image
     chose = ChosenComponents()
@@ -38,7 +38,7 @@ def stack_settings(tmp_path, image, qapp):
 
 
 @pytest.fixture()
-def part_settings_with_project(image, analysis_segmentation2, tmp_path, qapp):
+def part_settings_with_project(image, analysis_segmentation2, tmp_path):
     settings = PartSettings(tmp_path)
     settings.image = image
     settings.set_project_info(analysis_segmentation2)

package/tests/test_PartSeg/roi_analysis/test_advanced_window.py

@@ -148,10 +148,10 @@ def test_base_steep(self, qtbot, part_settings):
             widget.profile_name.setText("test")
         assert widget.save_butt.isEnabled()
 
-        assert len(part_settings.measurement_profiles) == 2
+        assert len(part_settings.measurement_profiles) == 3
         with qtbot.waitSignal(widget.save_butt.clicked):
             widget.save_butt.click()
-        assert len(part_settings.measurement_profiles) == 3
+        assert len(part_settings.measurement_profiles) == 4
 
         with qtbot.waitSignal(widget.profile_name.textChanged):
             widget.profile_name.setText("")