QVideo 3.4.1__tar.gz → 3.4.2__tar.gz

{qvideo-3.4.1 → qvideo-3.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: QVideo
-Version: 3.4.1
+Version: 3.4.2
 Summary: PyQt-based framework for integrating video cameras into research applications
 Author-email: "David G. Grier" <david.grier@nyu.edu>
 License: GPL-3.0-or-later

{qvideo-3.4.1 → qvideo-3.4.2}/QVideo.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: QVideo
-Version: 3.4.1
+Version: 3.4.2
 Summary: PyQt-based framework for integrating video cameras into research applications
 Author-email: "David G. Grier" <david.grier@nyu.edu>
 License: GPL-3.0-or-later

{qvideo-3.4.1 → qvideo-3.4.2}/lib/QVideoScreen.py

@@ -53,6 +53,7 @@ class QVideoScreen(GraphicsLayoutWidget):
         self.framerate = framerate
         self._ready = True
         self._pending = None
+        self._overlays = []
         self._setupUi()
         self._timer = QtCore.QTimer()
         self._source = None
@@ -70,6 +71,38 @@ class QVideoScreen(GraphicsLayoutWidget):
         self.image = ImageItem(axisOrder='row-major')
         self.view.addItem(self.image)
 
+    def addOverlay(self, item) -> None:
+        '''Add a graphics item to the view and register it for visibility control.
+
+        Parameters
+        ----------
+        item : pyqtgraph.GraphicsObject
+            The overlay item to add.
+        '''
+        self.view.addItem(item)
+        self._overlays.append(item)
+
+    def removeOverlay(self, item) -> None:
+        '''Remove a previously added graphics item from the view.
+
+        Parameters
+        ----------
+        item : pyqtgraph.GraphicsObject
+            The overlay item to remove.
+        '''
+        self.view.removeItem(item)
+        self._overlays.remove(item)
+
+    @property
+    def overlaysVisible(self) -> bool:
+        '''Whether any registered overlay is currently visible.'''
+        return any(item.isVisible() for item in self._overlays)
+
+    @overlaysVisible.setter
+    def overlaysVisible(self, visible: bool) -> None:
+        for item in self._overlays:
+            item.setVisible(visible)
+
     @property
     def framerate(self) -> int | None:
         '''Maximum display frame rate [fps].

{qvideo-3.4.1 → qvideo-3.4.2}/overlays/trackpy.py

@@ -210,9 +210,19 @@ class QTrackpyWidget(QtWidgets.QGroupBox):
         Parameters
         ----------
         screen : QVideoScreen
-            The screen whose :attr:`view` will host the overlay.
+            The screen that will host the overlay.
         '''
-        screen.view.addItem(self._overlay)
+        screen.addOverlay(self._overlay)
+
+    def detachFrom(self, screen) -> None:
+        '''Remove the overlay graphics item from *screen*.
+
+        Parameters
+        ----------
+        screen : QVideoScreen
+            The screen currently hosting the overlay.
+        '''
+        screen.removeOverlay(self._overlay)
 
     @QtCore.pyqtSlot(np.ndarray)
     def _onNewFrame(self, image: Image) -> None:

{qvideo-3.4.1 → qvideo-3.4.2}/overlays/yolo.py

@@ -227,9 +227,19 @@ class QYoloWidget(QtWidgets.QGroupBox):
         Parameters
         ----------
         screen : QVideoScreen
-            The screen whose :attr:`view` will host the overlay.
+            The screen that will host the overlay.
         '''
-        screen.view.addItem(self._overlay)
+        screen.addOverlay(self._overlay)
+
+    def detachFrom(self, screen) -> None:
+        '''Remove the overlay graphics item from *screen*.
+
+        Parameters
+        ----------
+        screen : QVideoScreen
+            The screen currently hosting the overlay.
+        '''
+        screen.removeOverlay(self._overlay)
 
     @QtCore.pyqtSlot(np.ndarray)
     def _onNewFrame(self, image: Image) -> None:

{qvideo-3.4.1 → qvideo-3.4.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "QVideo"
-version = "3.4.1"
+version = "3.4.2"
 description = "PyQt-based framework for integrating video cameras into research applications"
 readme = "README.md"
 license = { text = "GPL-3.0-or-later" }

{qvideo-3.4.1 → qvideo-3.4.2}/tests/test_qvideoscreen.py

@@ -297,5 +297,87 @@ class TestUpdateShape(unittest.TestCase):
         mock_geom.assert_called_once()
 
 
+class TestOverlays(unittest.TestCase):
+
+    def _make_mock_item(self, visible=True):
+        item = MagicMock()
+        item.isVisible.return_value = visible
+        return item
+
+    def test_overlays_empty_on_init(self):
+        screen = make_screen()
+        self.assertEqual(screen._overlays, [])
+
+    def test_add_overlay_appends_to_list(self):
+        screen = make_screen()
+        item = self._make_mock_item()
+        with patch.object(screen.view, 'addItem'):
+            screen.addOverlay(item)
+        self.assertIn(item, screen._overlays)
+
+    def test_add_overlay_calls_view_add_item(self):
+        screen = make_screen()
+        item = self._make_mock_item()
+        with patch.object(screen.view, 'addItem') as mock_add:
+            screen.addOverlay(item)
+        mock_add.assert_called_once_with(item)
+
+    def test_overlays_visible_false_when_none_registered(self):
+        screen = make_screen()
+        self.assertFalse(screen.overlaysVisible)
+
+    def test_overlays_visible_true_when_any_visible(self):
+        screen = make_screen()
+        with patch.object(screen.view, 'addItem'):
+            screen.addOverlay(self._make_mock_item(visible=False))
+            screen.addOverlay(self._make_mock_item(visible=True))
+        self.assertTrue(screen.overlaysVisible)
+
+    def test_overlays_visible_false_when_all_hidden(self):
+        screen = make_screen()
+        with patch.object(screen.view, 'addItem'):
+            screen.addOverlay(self._make_mock_item(visible=False))
+            screen.addOverlay(self._make_mock_item(visible=False))
+        self.assertFalse(screen.overlaysVisible)
+
+    def test_set_overlays_visible_true(self):
+        screen = make_screen()
+        items = [self._make_mock_item(visible=False) for _ in range(3)]
+        with patch.object(screen.view, 'addItem'):
+            for item in items:
+                screen.addOverlay(item)
+        screen.overlaysVisible = True
+        for item in items:
+            item.setVisible.assert_called_once_with(True)
+
+    def test_set_overlays_visible_false(self):
+        screen = make_screen()
+        items = [self._make_mock_item(visible=True) for _ in range(3)]
+        with patch.object(screen.view, 'addItem'):
+            for item in items:
+                screen.addOverlay(item)
+        screen.overlaysVisible = False
+        for item in items:
+            item.setVisible.assert_called_once_with(False)
+
+    def test_remove_overlay_removes_from_list(self):
+        screen = make_screen()
+        item = self._make_mock_item()
+        with patch.object(screen.view, 'addItem'):
+            screen.addOverlay(item)
+        with patch.object(screen.view, 'removeItem'):
+            screen.removeOverlay(item)
+        self.assertNotIn(item, screen._overlays)
+
+    def test_remove_overlay_calls_view_remove_item(self):
+        screen = make_screen()
+        item = self._make_mock_item()
+        with patch.object(screen.view, 'addItem'):
+            screen.addOverlay(item)
+        with patch.object(screen.view, 'removeItem') as mock_remove:
+            screen.removeOverlay(item)
+        mock_remove.assert_called_once_with(item)
+
+
 if __name__ == '__main__':
     unittest.main()

{qvideo-3.4.1 → qvideo-3.4.2}/tests/test_trackpy_overlay.py

@@ -44,6 +44,8 @@ class MockSource(QtCore.QObject):
 class MockScreen:
     def __init__(self):
         self.view = MagicMock()
+        self.addOverlay = MagicMock()
+        self.removeOverlay = MagicMock()
 
 
 # ---------------------------------------------------------------------------
@@ -294,7 +296,13 @@ class TestQTrackpyWidgetAttachTo(unittest.TestCase):
         w = _make_widget()
         screen = MockScreen()
         w.attachTo(screen)
-        screen.view.addItem.assert_called_once_with(w._overlay)
+        screen.addOverlay.assert_called_once_with(w._overlay)
+
+    def test_detach_from_removes_overlay(self):
+        w = _make_widget()
+        screen = MockScreen()
+        w.detachFrom(screen)
+        screen.removeOverlay.assert_called_once_with(w._overlay)
 
 
 class TestQTrackpyWidgetDiameter(unittest.TestCase):

{qvideo-3.4.1 → qvideo-3.4.2}/tests/test_yolo_overlay.py

@@ -61,6 +61,8 @@ class MockSource(QtCore.QObject):
 class MockScreen:
     def __init__(self):
         self.view = MagicMock()
+        self.addOverlay = MagicMock()
+        self.removeOverlay = MagicMock()
 
 
 def _make_widget(**kwargs):
@@ -283,7 +285,13 @@ class TestQYoloWidgetAttachTo(unittest.TestCase):
         w = _make_widget()
         screen = MockScreen()
         w.attachTo(screen)
-        screen.view.addItem.assert_called_once_with(w._overlay)
+        screen.addOverlay.assert_called_once_with(w._overlay)
+
+    def test_detach_from_removes_overlay(self):
+        w = _make_widget()
+        screen = MockScreen()
+        w.detachFrom(screen)
+        screen.removeOverlay.assert_called_once_with(w._overlay)
 
 
 class TestQYoloWidgetConfidence(unittest.TestCase):