add mask text label

Co-Authored-By: Jenna Tomkinson <107513215+jenna-tomkinson@users.noreply.github.com>

Author: d33bs

src/cytodataframe/frame.py

@@ -1332,11 +1332,41 @@ def _find_matching_segmentation_path(
             return matching_files[0] if matching_files else None
 
         for file_pattern, original_pattern in pattern_map.items():
-            if not re.search(original_pattern, data_value):
+            matched = re.search(original_pattern, data_value)
+            if not matched:
                 continue
-            for file in sorted(root.rglob("*")):
-                if re.search(file_pattern, file.name):
-                    return file
+            identifiers: list[str] = []
+            identifiers.extend(
+                str(group)
+                for group in matched.groups()
+                if isinstance(group, str) and group.strip()
+            )
+            identifiers.extend(
+                [
+                    pathlib.Path(data_value).stem,
+                    pathlib.Path(candidate_path).stem,
+                ]
+            )
+            identifiers = list(dict.fromkeys(idf for idf in identifiers if idf))
+
+            candidate_roots: list[pathlib.Path] = []
+            parent_name = pathlib.Path(candidate_path).parent.name
+            if parent_name:
+                parent_scoped_root = root / parent_name
+                if parent_scoped_root.exists():
+                    candidate_roots.append(parent_scoped_root)
+            candidate_roots.append(root)
+
+            for search_root in candidate_roots:
+                matching_files = [
+                    file
+                    for file in sorted(search_root.rglob("*"))
+                    if file.is_file()
+                    and re.search(file_pattern, file.name)
+                    and any(idf in file.stem for idf in identifiers)
+                ]
+                if matching_files:
+                    return matching_files[0]
         return None
 
     def _prepare_3d_label_overlay(
@@ -2619,7 +2649,7 @@ def _resolve_plotter_window_height(
             return int(height_digits.group(0))
         return 300
 
-    def _add_label_overlay_toggle_control(
+    def _add_label_overlay_toggle_control(  # noqa: C901
         self: CytoDataFrame_type,
         plotter: Any,
         overlay_actors: List[Any],
@@ -2654,6 +2684,80 @@ def _toggle_overlay(state: Any) -> None:
                 size=size,
                 position=position,
             )
+            label_text = str(display_options.get("label_overlay_toggle_label", "Mask"))
+            label_font_size = int(
+                display_options.get("label_overlay_toggle_font_size", 9)
+            )
+            label_gap = int(display_options.get("label_overlay_toggle_label_gap", 24))
+            label_shift_left = int(
+                display_options.get("label_overlay_toggle_label_shift_left", 212)
+            )
+            estimated_text_px = int(max(32, len(label_text) * label_font_size * 0.95))
+            label_pos = (
+                max(
+                    0,
+                    int(position[0]) - estimated_text_px - label_gap - label_shift_left,
+                ),
+                max(0, int(position[1]) + 10),
+            )
+            window_size = getattr(plotter, "window_size", None)
+            window_width = 300
+            if (
+                isinstance(window_size, (tuple, list))
+                and len(window_size) >= MIN_POSITION_COMPONENTS
+                and isinstance(window_size[0], (int, float))
+            ):
+                window_width = int(window_size[0])
+            window_width = max(1, window_width)
+            window_height = max(
+                1,
+                self._resolve_plotter_window_height(
+                    plotter=plotter,
+                    display_options=display_options,
+                ),
+            )
+            label_pos_norm = (
+                max(0.01, min(0.95, float(label_pos[0]) / float(window_width))),
+                max(0.01, min(0.95, float(label_pos[1]) / float(window_height))),
+            )
+            label_name = f"cdf-label-toggle-{uuid.uuid4().hex}"
+            text_added = False
+            try:
+                plotter.add_text(
+                    label_text,
+                    position=label_pos_norm,
+                    font_size=label_font_size,
+                    color="white",
+                    name=label_name,
+                    viewport=True,
+                    shadow=True,
+                )
+                text_added = True
+            except Exception:
+                pass
+            if not text_added:
+                try:
+                    plotter.add_text(
+                        label_text,
+                        position=label_pos,
+                        font_size=label_font_size,
+                        color="white",
+                        name=label_name,
+                        shadow=True,
+                    )
+                    text_added = True
+                except Exception:
+                    pass
+            if not text_added:
+                with contextlib.suppress(Exception):
+                    plotter.add_text(
+                        label_text,
+                        position="lower_right",
+                        font_size=label_font_size,
+                        color="white",
+                        name=label_name,
+                        shadow=True,
+                    )
             logger.debug("Added 3D label overlay toggle checkbox to plotter view.")
 
     def _toggle_overlay_actors_visibility(

tests/test_frame.py

@@ -360,6 +360,45 @@ def test_get_3d_label_overlay_from_cell_applies_bbox_crop(
     assert overlay.max() == 255
 
 
+def test_find_matching_segmentation_path_filters_by_image_identifier(
+    tmp_path: pathlib.Path,
+) -> None:
+    mask_dir = tmp_path / "masks"
+    mask_dir.mkdir()
+    (mask_dir / "img_a_mask.tiff").write_bytes(b"")
+    (mask_dir / "img_b_mask.tiff").write_bytes(b"")
+
+    matched = CytoDataFrame._find_matching_segmentation_path(
+        data_value="img_a.tiff",
+        pattern_map={r".*_mask\.tiff$": r".*"},
+        file_dir=str(mask_dir),
+        candidate_path=pathlib.Path("img_a.tiff"),
+    )
+
+    assert matched is not None
+    assert matched.name == "img_a_mask.tiff"
+
+
+def test_find_matching_segmentation_path_prefers_candidate_parent_tree(
+    tmp_path: pathlib.Path,
+) -> None:
+    mask_dir = tmp_path / "masks"
+    (mask_dir / "plate_a").mkdir(parents=True)
+    (mask_dir / "plate_b").mkdir(parents=True)
+    (mask_dir / "plate_a" / "nuclei1_mask.tiff").write_bytes(b"")
+    (mask_dir / "plate_b" / "nuclei1_mask.tiff").write_bytes(b"")
+
+    matched = CytoDataFrame._find_matching_segmentation_path(
+        data_value="plate_a/nuclei1.tiff",
+        pattern_map={r".*_mask\.tiff$": r".*"},
+        file_dir=str(mask_dir),
+        candidate_path=pathlib.Path("/tmp/plate_a/nuclei1.tiff"),
+    )
+
+    assert matched is not None
+    assert matched.parent.name == "plate_a"
+
+
 def test_cytodataframe_input(
     tmp_path: pathlib.Path,
     basic_outlier_dataframe: pd.DataFrame,
@@ -1164,6 +1203,8 @@ def fake_build_pyvista_viewer(**kwargs: object):  # noqa: ANN202
     assert captured["backend"] == "trame"
     assert captured["widget_height"] == "140px"
     assert isinstance(captured.get("label_volume"), np.ndarray)
+    assert isinstance(grid[1, 1], widgets.Box)
+    assert len(grid[1, 1].children) == 1
 
 
 def test_get_displayed_rows_when_under_limit(monkeypatch: pytest.MonkeyPatch):
@@ -1397,6 +1438,7 @@ def test_add_label_overlay_toggle_control_toggles_overlay_actor_visibility() ->
     toggles: list[int] = []
     renders: list[bool] = []
     checkbox_kwargs: dict[str, object] = {}
+    label_kwargs: dict[str, object] = {}
 
     class FakeActor:
         def SetVisibility(self, value: int) -> None:
@@ -1420,6 +1462,9 @@ def add_checkbox_button_widget(
             checkbox_kwargs["size"] = size
             checkbox_kwargs["position"] = position
 
+        def add_text(self, *_args: object, **kwargs: object) -> None:
+            label_kwargs.update(kwargs)
+
     actor = FakeActor()
     plotter = FakePlotter()
     cdf._add_label_overlay_toggle_control(
@@ -1431,6 +1476,12 @@ def add_checkbox_button_widget(
     assert checkbox_kwargs["value"] is True
     assert checkbox_kwargs["size"] == 24
     assert checkbox_kwargs["position"] == (266, 10)
+    label_position = label_kwargs["position"]
+    assert isinstance(label_position, tuple)
+    assert label_position == pytest.approx((0.01, 20 / 300))
+    assert label_kwargs["viewport"] is True
+    assert label_kwargs["color"] == "white"
+    assert label_kwargs["font_size"] == 9
     callback = checkbox_kwargs["callback"]
     assert callable(callback)