From 90cc773ba8d8b0e30ab379e71ff49a3f51d9bc15 Mon Sep 17 00:00:00 2001 From: Peter Corke Date: Fri, 20 Nov 2026 14:50:30 +1000 Subject: [PATCH] feat: use spatialmath's set_window_title and remove MVTB's own spatialmath-python 1.1.19, already the minimum, has set_window_title(fig, title), which does nothing for a figure with no window. MVTB had its own set_window_title(title) on the current figure, exported publicly, and six places that set the title directly with a try/except or a manager check. All use the spatialmath function now, and the local helper and its exports are gone. Code that imported set_window_title from MVTB should import it from spatialmath.base, which takes the figure as its first argument. Fixes #147 Co-Authored-By: Claude Sonnet 5.5 --- examples/morphdemo.py | 5 ++- src/machinevisiontoolbox/Camera.py | 11 ++---- src/machinevisiontoolbox/ImageProcessing.py | 16 +++++--- .../ImageWholeFeatures.py | 5 ++- src/machinevisiontoolbox/VisualServo.py | 10 ++--- src/machinevisiontoolbox/__init__.py | 1 - src/machinevisiontoolbox/base/__init__.py | 1 - src/machinevisiontoolbox/base/imageio.py | 13 ++----- .../bin/_iminteractive.py | 7 ++-- tests/test_window_title.py | 37 +++++++++++++++++++ tests/test_window_title_errors.py | 31 ---------------- 11 files changed, 65 insertions(+), 72 deletions(-) create mode 100644 tests/test_window_title.py delete mode 100644 tests/test_window_title_errors.py diff --git a/examples/morphdemo.py b/examples/morphdemo.py index 2d9555bf..fcccb56c 100755 --- a/examples/morphdemo.py +++ b/examples/morphdemo.py @@ -9,7 +9,8 @@ import matplotlib.pyplot as plt import numpy as np -from machinevisiontoolbox import Image, set_window_title +from machinevisiontoolbox import Image +from spatialmath.base import set_window_title parser = argparse.ArgumentParser( description="Demonstration of morphological operations." @@ -80,7 +81,7 @@ def _encode_movie(frame_dir: Path, movie_file: str, fps: float) -> None: # create two adjacent subplots, and display the input image on the left fig, (input, output) = plt.subplots(1, 2, figsize=(10, 5)) -set_window_title("Morphological operation demonstration") +set_window_title(fig, "Morphological operation demonstration") img.showpixels(ax=input) # display the input image and get a window annotator window = img.showwindow( diff --git a/src/machinevisiontoolbox/Camera.py b/src/machinevisiontoolbox/Camera.py index 8114f6f4..653581bb 100644 --- a/src/machinevisiontoolbox/Camera.py +++ b/src/machinevisiontoolbox/Camera.py @@ -21,7 +21,7 @@ # from mpl_toolkits.mplot3d import Axes3D, art3d from mpl_toolkits.mplot3d.art3d import Poly3DCollection from spatialmath import SE3, Line3 -from spatialmath.base import isnotebook +from spatialmath.base import isnotebook, set_window_title from machinevisiontoolbox import Image from machinevisiontoolbox.base.imageio import idisp, safe_plt_show @@ -812,13 +812,8 @@ def _init_imageplane( ax.set_title(self.name) ax.set_facecolor("lightyellow") - try: - ax.figure.canvas.manager.set_window_title( # type: ignore[union-attr] - "Machine Vision Toolbox for Python" - ) - except AttributeError: - # can happen during unit test without GUI - pass + # does nothing on a backend with no window, as in a unit test + set_window_title(ax.figure, "Machine Vision Toolbox for Python") # TODO figure out axes ticks, etc return ax # likely this return is not necessary diff --git a/src/machinevisiontoolbox/ImageProcessing.py b/src/machinevisiontoolbox/ImageProcessing.py index d62ac80e..28c44db7 100644 --- a/src/machinevisiontoolbox/ImageProcessing.py +++ b/src/machinevisiontoolbox/ImageProcessing.py @@ -17,7 +17,14 @@ # from numpy.lib.arraysetops import isin import scipy as sp from scipy import interpolate -from spatialmath.base import argcheck, e2h, getvector, h2e, transl2 +from spatialmath.base import ( + argcheck, + e2h, + getvector, + h2e, + set_window_title, + transl2, +) from machinevisiontoolbox._image_typing import ImageMixinBase from machinevisiontoolbox.base.color import name2color @@ -675,11 +682,8 @@ def apply_mode(threshold): fig, axs = plt.subplots(1, 2, figsize=(10, 5)) plt.subplots_adjust(bottom=0.1 if _use_ipywidgets else 0.25) - try: - if title is not None and fig.canvas.manager is not None: - fig.canvas.manager.set_window_title(title) # for 3.4 onward - except Exception: - pass + if title is not None: + set_window_title(fig, title) im = axs[0].imshow(apply_mode(t), cmap="gray") if mode == "binary": diff --git a/src/machinevisiontoolbox/ImageWholeFeatures.py b/src/machinevisiontoolbox/ImageWholeFeatures.py index 1296134c..1a4cf86a 100644 --- a/src/machinevisiontoolbox/ImageWholeFeatures.py +++ b/src/machinevisiontoolbox/ImageWholeFeatures.py @@ -15,13 +15,14 @@ from matplotlib.patches import Polygon from matplotlib.ticker import ScalarFormatter from spatialmath import SE3, base +from spatialmath.base import set_window_title if TYPE_CHECKING: from machinevisiontoolbox._image_typing import _ImageBase from machinevisiontoolbox._image_typing import ImageMixinBase from machinevisiontoolbox.base.findpeaks import findpeaks, findpeaks2d -from machinevisiontoolbox.base.imageio import safe_plt_show, set_window_title +from machinevisiontoolbox.base.imageio import safe_plt_show from machinevisiontoolbox.mvtb_types import * @@ -1589,7 +1590,7 @@ def on_move(event): raise ValueError("unknown style") if title is not None: - set_window_title(title) + set_window_title(plt.gcf(), title) safe_plt_show(block=block) def _compute_plot_series( diff --git a/src/machinevisiontoolbox/VisualServo.py b/src/machinevisiontoolbox/VisualServo.py index 750cac54..1fc9d44f 100644 --- a/src/machinevisiontoolbox/VisualServo.py +++ b/src/machinevisiontoolbox/VisualServo.py @@ -11,7 +11,7 @@ import numpy as np import spatialmath.base as smbase from spatialmath import SE3 -from spatialmath.base import Animate +from spatialmath.base import Animate, set_window_title from machinevisiontoolbox import CentralCamera from machinevisiontoolbox.base.shapes import mkgrid @@ -132,8 +132,7 @@ def __init__( self.ax_3dview.set_facecolor("#f0f0f0") if title is not None: - if self.fig.canvas.manager is not None: - self.fig.canvas.manager.set_window_title(title) + set_window_title(self.fig, title) def step(self, t: float) -> int: """Compute one timestep of the simulation, implemented by subclasses.""" @@ -1795,10 +1794,7 @@ def _init_imageplane(self, fig: Any = None, ax: Any = None) -> Any: ax.set_title(self.name) ax.set_facecolor("lightyellow") - try: - ax.figure.canvas.set_window_title("Machine Vision Toolbox for Python") - except AttributeError: - pass + set_window_title(ax.figure, "Machine Vision Toolbox for Python") # TODO figure out axes ticks, etc return ax # likely this return is not necessary diff --git a/src/machinevisiontoolbox/__init__.py b/src/machinevisiontoolbox/__init__.py index fae32c89..fc75fb0f 100644 --- a/src/machinevisiontoolbox/__init__.py +++ b/src/machinevisiontoolbox/__init__.py @@ -128,7 +128,6 @@ iwrite, convert, cv_destroy_window, - set_window_title, pickpoints, ) diff --git a/src/machinevisiontoolbox/base/__init__.py b/src/machinevisiontoolbox/base/__init__.py index c5afbde5..7ad6063f 100644 --- a/src/machinevisiontoolbox/base/__init__.py +++ b/src/machinevisiontoolbox/base/__init__.py @@ -50,7 +50,6 @@ "iwrite", "convert", "cv_destroy_window", - "set_window_title", "pickpoints", "safe_plt_show", # types diff --git a/src/machinevisiontoolbox/base/imageio.py b/src/machinevisiontoolbox/base/imageio.py index 1f0b5679..bfd096d1 100644 --- a/src/machinevisiontoolbox/base/imageio.py +++ b/src/machinevisiontoolbox/base/imageio.py @@ -36,6 +36,7 @@ # import pyautogui # requires pip install pyautogui from spatialmath.base import islistof +from spatialmath.base import set_window_title as _set_window_title __last_windowname: str | None = None __last_window_number: int = 0 @@ -579,7 +580,7 @@ def _idisp_matplotlib( c.set_data(im) updated = True if updated: - set_window_title(title) + _set_window_title(ax.figure, title) if fps is not None: # print("pausing", 1.0 / fps) @@ -599,7 +600,7 @@ def _idisp_matplotlib( if fig is None: fig = ax.figure - set_window_title(title) + _set_window_title(fig, title) # aspect ratio: if not square: mpl.rcParams["image.aspect"] = "auto" @@ -1029,14 +1030,6 @@ def _idisp_opencv( # window/set of axes? -def set_window_title(title: str) -> None: - try: - _plt().gcf().canvas.manager.set_window_title(title) # for 3.4 onward - except (AttributeError, RuntimeError): - # Some noninteractive backends do not have a usable window manager. - pass - - def cv_destroy_window(title: str | None = None, block: bool = True) -> None: if title == "all": cv2.destroyAllWindows() diff --git a/src/machinevisiontoolbox/bin/_iminteractive.py b/src/machinevisiontoolbox/bin/_iminteractive.py index a669043a..26ed7748 100644 --- a/src/machinevisiontoolbox/bin/_iminteractive.py +++ b/src/machinevisiontoolbox/bin/_iminteractive.py @@ -10,6 +10,7 @@ import faulthandler import matplotlib.pyplot as plt from matplotlib.patches import Circle, Rectangle +from spatialmath.base import set_window_title import numpy as np # Enable C-level crash tracebacks (SIGSEGV, SIGBUS, etc.) @@ -252,8 +253,7 @@ def _show_profile(self, u0: float, v0: float, u1: float, v1: float) -> None: arr = image.array pfig, pax = plt.subplots() - if pfig.canvas.manager is not None: - pfig.canvas.manager.set_window_title("Intensity profile") + set_window_title(pfig, "Intensity profile") if arr.ndim == 2: pax.plot(arr[vi, ui]) @@ -428,8 +428,7 @@ def _popup_hist(self, roi, *, cumulative: bool) -> None: kwargs["type"] = "cdf" roi.hist().plot(**kwargs) fig = plt.gcf() - if fig.canvas.manager is not None: - fig.canvas.manager.set_window_title(title) + set_window_title(fig, title) fig.canvas.draw_idle() # safe from event callbacks – just schedules NSTimer self._popup_figs.append( fig diff --git a/tests/test_window_title.py b/tests/test_window_title.py new file mode 100644 index 00000000..3edff3ab --- /dev/null +++ b/tests/test_window_title.py @@ -0,0 +1,37 @@ +"""Images are displayed in a window with the title that was asked for.""" + +import matplotlib + +matplotlib.use("Agg") + +import matplotlib.pyplot as plt +import pytest + +from machinevisiontoolbox import Image + + +@pytest.fixture(autouse=True) +def close_figures(): + yield + plt.close("all") + + +def test_disp_sets_the_window_title(): + Image.Random(size=(8, 6)).disp(title="my title", block=False) + assert plt.gcf().canvas.manager.get_window_title() == "my title" + + +def test_redisplay_in_the_same_axes_updates_the_window_title(): + fig, ax = plt.subplots() + image = Image.Random(size=(8, 6)) + image.disp(ax=ax, title="first", block=False) + image.disp(ax=ax, title="second", block=False) + assert fig.canvas.manager.get_window_title() == "second" + + +def test_the_removed_local_helper_is_not_exported(): + import machinevisiontoolbox + from machinevisiontoolbox import base + + assert not hasattr(machinevisiontoolbox, "set_window_title") + assert "set_window_title" not in base.__all__ diff --git a/tests/test_window_title_errors.py b/tests/test_window_title_errors.py deleted file mode 100644 index 67bbca75..00000000 --- a/tests/test_window_title_errors.py +++ /dev/null @@ -1,31 +0,0 @@ -from types import SimpleNamespace -from unittest.mock import Mock, patch - -import pytest - -from machinevisiontoolbox.base import imageio - - -def test_window_title_is_forwarded(): - """Forward the title to a supported window manager.""" - manager = Mock() - figure = SimpleNamespace(canvas=SimpleNamespace(manager=manager)) - with patch.object(imageio, "_plt") as pyplot: - pyplot.return_value.gcf.return_value = figure - imageio.set_window_title("camera") - manager.set_window_title.assert_called_once_with("camera") - - -@pytest.mark.parametrize("error", [AttributeError, RuntimeError]) -def test_unsupported_window_title_is_ignored(error): - """Tolerate window managers that cannot set a title.""" - with patch.object(imageio, "_plt", side_effect=error("unsupported")): - imageio.set_window_title("camera") - - -@pytest.mark.parametrize("error", [ValueError, KeyboardInterrupt]) -def test_unexpected_window_title_errors_propagate(error): - """Do not hide unrelated failures or user interrupts.""" - with patch.object(imageio, "_plt", side_effect=error()): - with pytest.raises(error): - imageio.set_window_title("camera")