add smoothed label rendering modes (#129)

Author: kevinyamauchi

src/cellier/convenience/gui/_controls_config.py

@@ -344,6 +344,7 @@ class DatasetInfoControl(Control):
     "visible": "visible",
     "opacity": "opacity",
     "render_mode": "labels_render_mode",
+    "smooth_geometry_level": "smooth_geometry_level",
     "salt": "salt",
     "background_label": "background_label",
 }

src/cellier/gui/_appearance_fields.py

@@ -308,6 +308,7 @@ def as_rgba(value: Any) -> tuple[float, float, float, float]:
     # kind rather than the kind being the field (design section 6.5.2
     # decision 6).
     "labels_render_mode": ("LabelsRenderModeCombo", "Render mode"),
+    "smooth_geometry_level": ("SmoothGeometryLevelSlider", "Smooth geometry level"),
     "salt": ("SaltSpin", "Salt"),
     "background_label": ("BackgroundLabelSpin", "Background label"),
     # Mesh, points and lines all spell the uniform colour ``color``.

src/cellier/gui/anywidget/visuals/__init__.py

@@ -32,6 +32,7 @@
     AnywidgetBackgroundLabelSpin,
     AnywidgetLabelsRenderModeCombo,
     AnywidgetSaltSpin,
+    AnywidgetSmoothGeometryLevelSlider,
 )
 from cellier.gui.anywidget.visuals._level_of_detail import (
     AnywidgetLevelOfDetailControls,
@@ -95,6 +96,7 @@
     "AnywidgetSideCombo",
     "AnywidgetSizeSpaceCombo",
     "AnywidgetSizeSpin",
+    "AnywidgetSmoothGeometryLevelSlider",
     "AnywidgetThicknessSpaceCombo",
     "AnywidgetThicknessSpin",
     "AnywidgetToggle",

src/cellier/gui/anywidget/visuals/_labels.py

@@ -11,10 +11,13 @@
 
 from typing import ClassVar
 
+from cellier.gui._appearance_fields import field_bounds
 from cellier.gui.anywidget.visuals._base import (
+    AnywidgetBoundedSlider,
     AnywidgetChoice,
     AnywidgetIntSpin,
 )
+from cellier.visuals._label_memory import BaseLabelsAppearance
 
 
 class AnywidgetLabelsRenderModeCombo(AnywidgetChoice):
@@ -88,3 +91,32 @@ class AnywidgetBackgroundLabelSpin(AnywidgetIntSpin):
     _label: ClassVar[str] = "Background label"
     _default_value: ClassVar[int] = 0
     _default_range: ClassVar[tuple[int, int]] = (-(2**31), 2**31 - 1)
+
+
+_SMOOTH_GEOMETRY_LEVEL_RANGE = field_bounds(
+    BaseLabelsAppearance, "smooth_geometry_level"
+) or (0.05, 0.95)
+"""Read off the model, so the slider cannot offer a value pydantic rejects."""
+
+
+class AnywidgetSmoothGeometryLevelSlider(AnywidgetBoundedSlider):
+    """Where the ``smooth_geometry`` surface sits.
+
+    The share of the blended weight a label must carry.  Lower grows every
+    label, higher shrinks it; 0.5 puts flat sides on the voxel faces.  No
+    effect in the other render modes.
+
+    Parameters
+    ----------
+    visual_id :
+        UUID of the visual, or a sequence of UUIDs to drive as one
+        group.
+    initial_value :
+        Starting value -- typically
+        ``visual.appearance.smooth_geometry_level``.
+    """
+
+    _field: ClassVar[str] = "smooth_geometry_level"
+    _label: ClassVar[str] = "Smooth geometry level"
+    _default_value: ClassVar[float] = 0.5
+    _default_range: ClassVar[tuple[float, float]] = _SMOOTH_GEOMETRY_LEVEL_RANGE

src/cellier/gui/qt/visuals/__init__.py

@@ -33,6 +33,7 @@
     QtBackgroundLabelSpin,
     QtLabelsRenderModeCombo,
     QtSaltSpin,
+    QtSmoothGeometryLevelSlider,
 )
 from cellier.gui.qt.visuals._level_of_detail import QtLevelOfDetailControls
 from cellier.gui.qt.visuals._lines import (
@@ -92,6 +93,7 @@
     "QtSideCombo",
     "QtSizeSpaceCombo",
     "QtSizeSpin",
+    "QtSmoothGeometryLevelSlider",
     "QtThicknessSpaceCombo",
     "QtThicknessSpin",
     "QtToggle",

src/cellier/gui/qt/visuals/_labels.py

@@ -11,10 +11,13 @@
 
 from typing import ClassVar
 
+from cellier.gui._appearance_fields import field_bounds
 from cellier.gui.qt.visuals._base import (
+    QtBoundedSlider,
     QtChoice,
     QtIntSpin,
 )
+from cellier.visuals._label_memory import BaseLabelsAppearance
 
 
 class QtLabelsRenderModeCombo(QtChoice):
@@ -88,3 +91,32 @@ class QtBackgroundLabelSpin(QtIntSpin):
     _label: ClassVar[str] = "Background label"
     _default_value: ClassVar[int] = 0
     _default_range: ClassVar[tuple[int, int]] = (-(2**31), 2**31 - 1)
+
+
+_SMOOTH_GEOMETRY_LEVEL_RANGE = field_bounds(
+    BaseLabelsAppearance, "smooth_geometry_level"
+) or (0.05, 0.95)
+"""Read off the model, so the slider cannot offer a value pydantic rejects."""
+
+
+class QtSmoothGeometryLevelSlider(QtBoundedSlider):
+    """Where the ``smooth_geometry`` surface sits.
+
+    The share of the blended weight a label must carry.  Lower grows every
+    label, higher shrinks it; 0.5 puts flat sides on the voxel faces.  No
+    effect in the other render modes.
+
+    Parameters
+    ----------
+    visual_id :
+        UUID of the visual, or a sequence of UUIDs to drive as one
+        group.
+    initial_value :
+        Starting value -- typically
+        ``visual.appearance.smooth_geometry_level``.
+    """
+
+    _field: ClassVar[str] = "smooth_geometry_level"
+    _label: ClassVar[str] = "Smooth geometry level"
+    _default_value: ClassVar[float] = 0.5
+    _default_range: ClassVar[tuple[float, float]] = _SMOOTH_GEOMETRY_LEVEL_RANGE

src/cellier/render/shaders/_label_multiscale.py

@@ -79,24 +79,29 @@ class LabelVolumeBrickMaterial(gfx.VolumeBasicMaterial):
         Colormap mode (baked into shader; frozen after construction).
     salt : int
         Hash seed for random mode.
-    render_mode : "iso_categorical" | "flat_categorical" | "gradient_debug" \
-        | "smooth_iso"
-        3D render mode.  ``gradient_debug`` renders abs(normalize(gradient))
-        as RGB (R=|X|, G=|Y|, B=|Z|); flat regions with no gradient show as
-        solid blue.  Use to diagnose brick-boundary normal discontinuities.
-        ``smooth_iso`` uses a soft trilinear density field for bisection and
-        a 3x3x3 Sobel normal kernel for smooth curved shading.
+    render_mode : str
+        3D render mode (``MultiscaleLabelsAppearance.render_mode``).
+        ``gradient_debug`` renders abs(normalize(gradient)) as RGB (R=|X|,
+        G=|Y|, B=|Z|); flat regions with no gradient show as solid blue.
+        Use to diagnose brick-boundary normal discontinuities.
+        ``smooth_iso`` shades the voxel-face surface with a smooth normal;
+        ``smooth_geometry`` draws a smooth surface per label (both in
+        ``cellier.label_smooth.wgsl``).
     ray_steps_per_voxel : float
         Ray-march samples per voxel of the drawn level, measured along the
         ray.  Default is ``1.0``.
     render_planes_buffer : Buffer or None
         The visual's ``u_render_planes`` buffer, read in ``"plane"`` render
         mode.  ``None`` gives the material one of its own with no plane.
+    smooth_level : float
+        ``MultiscaleLabelsAppearance.smooth_geometry_level``: where the
+        ``smooth_geometry`` surface sits.  Default ``0.5``.
     """
 
     uniform_type: ClassVar[dict] = dict(
         gfx.VolumeBasicMaterial.uniform_type,
         ray_steps_per_voxel="f4",
+        smooth_level="f4",
     )
 
     def __init__(
@@ -117,10 +122,12 @@ def __init__(
         outline_selection_texture: gfx.Texture | None = None,
         ray_steps_per_voxel: float = 1.0,
         render_planes_buffer: Buffer | None = None,
+        smooth_level: float = 0.5,
         **kwargs,
     ) -> None:
         super().__init__(**kwargs)
         self.uniform_buffer.data["ray_steps_per_voxel"] = float(ray_steps_per_voxel)
+        self.uniform_buffer.data["smooth_level"] = float(smooth_level)
         self.uniform_buffer.update_full()
         self.render_planes_buffer = (
             render_planes_buffer
@@ -169,6 +176,19 @@ def ray_steps_per_voxel(self, value: float) -> None:
         self.uniform_buffer.data["ray_steps_per_voxel"] = float(value)
         self.uniform_buffer.update_full()
 
+    @property
+    def smooth_level(self) -> float:
+        """The field level of the ``smooth_geometry`` surface.
+
+        A uniform, so a change does not rebuild the shader.
+        """
+        return float(self.uniform_buffer.data["smooth_level"])
+
+    @smooth_level.setter
+    def smooth_level(self, value: float) -> None:
+        self.uniform_buffer.data["smooth_level"] = float(value)
+        self.uniform_buffer.update_full()
+
 
 # ---------------------------------------------------------------------------
 # 3D shader

src/cellier/render/shaders/_label_volume.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 from pathlib import Path
+from typing import ClassVar
 
 import pygfx as gfx
 import wgpu
@@ -41,9 +42,10 @@ class LabelVolumeMaterial(gfx.VolumeBasicMaterial):
         Frozen after construction.
     salt : int
         Hash seed for random mode.
-    render_mode : "iso_categorical", "flat_categorical" or "plane"
-        Whether to apply Lambertian shading; ``"plane"`` draws the labels
-        on the render planes instead.  A change rebuilds the shader.
+    render_mode : str
+        ``InMemoryLabelsAppearance.render_mode``: ``"iso_categorical"``,
+        ``"flat_categorical"``, ``"smooth_iso"``, ``"smooth_geometry"`` or
+        ``"plane"``.  A change rebuilds the shader.
     label_keys_texture : gfx.Texture or None
         Sorted int32 label-ID texture for direct mode.
     label_colors_texture : gfx.Texture or None
@@ -55,8 +57,16 @@ class LabelVolumeMaterial(gfx.VolumeBasicMaterial):
     render_planes_buffer : gfx.Buffer or None
         The visual's ``u_render_planes`` buffer, read in ``"plane"`` mode.
         ``None`` gives the material one of its own with no plane.
+    smooth_level : float
+        ``InMemoryLabelsAppearance.smooth_geometry_level``: where the
+        ``smooth_geometry`` surface sits.  Default ``0.5``.
     """
 
+    uniform_type: ClassVar[dict] = dict(
+        gfx.VolumeBasicMaterial.uniform_type,
+        smooth_level="f4",
+    )
+
     def __init__(
         self,
         background_label: int = 0,
@@ -69,9 +79,11 @@ def __init__(
         label_params_buffer=None,
         outline_selection_texture=None,
         render_planes_buffer=None,
+        smooth_level: float = 0.5,
         **kwargs,
     ) -> None:
         super().__init__(**kwargs)
+        self.smooth_level = smooth_level
         self.background_label = background_label
         self.colormap_mode = colormap_mode
         self.salt = salt
@@ -104,6 +116,19 @@ def render_mode(self) -> str:
     def render_mode(self, value: str) -> None:
         self._store.render_mode = value
 
+    @property
+    def smooth_level(self) -> float:
+        """The field level of the ``smooth_geometry`` surface.
+
+        A uniform, so a change does not rebuild the shader.
+        """
+        return float(self.uniform_buffer.data["smooth_level"])
+
+    @smooth_level.setter
+    def smooth_level(self, value: float) -> None:
+        self.uniform_buffer.data["smooth_level"] = float(value)
+        self.uniform_buffer.update_full()
+
 
 @register_wgpu_render_function(Volume, LabelVolumeMaterial)
 class LabelVolumeShader(BaseVolumeShader):