QVideo 3.4.0__tar.gz → 3.4.2__tar.gz

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

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: QVideo
-Version: 3.4.0
+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
 Project-URL: Homepage, https://github.com/davidgrier/QVideo
 Project-URL: Repository, https://github.com/davidgrier/QVideo
 Project-URL: Bug Tracker, https://github.com/davidgrier/QVideo/issues
-Keywords: camera,video,imaging,PyQt5,scientific,GenICam,GigE Vision,raspberry pi
+Keywords: camera,video,imaging,PyQt5,PyQt6,scientific,GenICam,GigE Vision,raspberry pi
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
@@ -24,15 +24,30 @@ License-File: LICENSE.md
 Requires-Dist: h5py
 Requires-Dist: numpy
 Requires-Dist: opencv-python
-Requires-Dist: PyQt5
-Requires-Dist: PyQt5-sip
+Requires-Dist: pandas
 Requires-Dist: pyqtgraph
+Provides-Extra: pyqt5
+Requires-Dist: PyQt5; extra == "pyqt5"
+Requires-Dist: PyQt5-sip; extra == "pyqt5"
+Provides-Extra: pyqt6
+Requires-Dist: PyQt6; extra == "pyqt6"
 Provides-Extra: genicam
 Requires-Dist: harvesters; extra == "genicam"
 Requires-Dist: genicam; extra == "genicam"
 Provides-Extra: picamera
 Requires-Dist: picamera2; extra == "picamera"
+Provides-Extra: dev-pyqt5
+Requires-Dist: PyQt5; extra == "dev-pyqt5"
+Requires-Dist: PyQt5-sip; extra == "dev-pyqt5"
+Requires-Dist: pytest; extra == "dev-pyqt5"
+Requires-Dist: pytest-cov; extra == "dev-pyqt5"
+Provides-Extra: dev-pyqt6
+Requires-Dist: PyQt6; extra == "dev-pyqt6"
+Requires-Dist: pytest; extra == "dev-pyqt6"
+Requires-Dist: pytest-cov; extra == "dev-pyqt6"
 Provides-Extra: dev
+Requires-Dist: PyQt5; extra == "dev"
+Requires-Dist: PyQt5-sip; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
 Provides-Extra: docs
@@ -48,8 +63,9 @@ Dynamic: license-file
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE.md)
 [![Tests](https://github.com/davidgrier/QVideo/actions/workflows/test.yml/badge.svg)](https://github.com/davidgrier/QVideo/actions/workflows/test.yml)
 [![Documentation](https://readthedocs.org/projects/qvideo/badge/?version=latest)](https://qvideo.readthedocs.io/en/latest/)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.19239402.svg)](https://doi.org/10.5281/zenodo.19239402)
 
-**QVideo** is a framework for integrating video cameras into PyQt5 projects
+**QVideo** is a framework for integrating video cameras into PyQt projects
 for scientific research.  It provides a unified, registration-based property
 system so that every camera backend — USB webcams, GenICam devices, FLIR
 cameras, Raspberry Pi cameras — is controlled through the same API.  Property
@@ -87,16 +103,15 @@ pip install QVideo
 |---------|-------|-------|
 | GenICam cameras (Vimba, etc.) | `pip install QVideo[genicam]` | Requires a vendor-supplied `.cti` producer file |
 | Raspberry Pi camera | `pip install QVideo[picamera]` | Requires `picamera2` |
-| FLIR / Spinnaker cameras | — | Requires the proprietary PySpin SDK; install that separately |
 
 ## Quick start
 
 ```python
-from pyqtgraph.Qt import QtWidgets
+import pyqtgraph as pg
 from QVideo.cameras.Noise import QNoiseSource
 from QVideo.lib import QVideoScreen
 
-app = QtWidgets.QApplication([])
+pg.mkApp()
 
 source = QNoiseSource()          # synthetic noise — no hardware needed
 screen = QVideoScreen()
@@ -104,7 +119,7 @@ source.newFrame.connect(screen.setImage)
 
 screen.show()
 source.start()
-app.exec()
+pg.exec()
 ```
 
 Replace `QNoiseSource` with `QOpenCVSource`, `QGenicamSource`, etc. to switch

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

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: QVideo
-Version: 3.4.0
+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
 Project-URL: Homepage, https://github.com/davidgrier/QVideo
 Project-URL: Repository, https://github.com/davidgrier/QVideo
 Project-URL: Bug Tracker, https://github.com/davidgrier/QVideo/issues
-Keywords: camera,video,imaging,PyQt5,scientific,GenICam,GigE Vision,raspberry pi
+Keywords: camera,video,imaging,PyQt5,PyQt6,scientific,GenICam,GigE Vision,raspberry pi
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
@@ -24,15 +24,30 @@ License-File: LICENSE.md
 Requires-Dist: h5py
 Requires-Dist: numpy
 Requires-Dist: opencv-python
-Requires-Dist: PyQt5
-Requires-Dist: PyQt5-sip
+Requires-Dist: pandas
 Requires-Dist: pyqtgraph
+Provides-Extra: pyqt5
+Requires-Dist: PyQt5; extra == "pyqt5"
+Requires-Dist: PyQt5-sip; extra == "pyqt5"
+Provides-Extra: pyqt6
+Requires-Dist: PyQt6; extra == "pyqt6"
 Provides-Extra: genicam
 Requires-Dist: harvesters; extra == "genicam"
 Requires-Dist: genicam; extra == "genicam"
 Provides-Extra: picamera
 Requires-Dist: picamera2; extra == "picamera"
+Provides-Extra: dev-pyqt5
+Requires-Dist: PyQt5; extra == "dev-pyqt5"
+Requires-Dist: PyQt5-sip; extra == "dev-pyqt5"
+Requires-Dist: pytest; extra == "dev-pyqt5"
+Requires-Dist: pytest-cov; extra == "dev-pyqt5"
+Provides-Extra: dev-pyqt6
+Requires-Dist: PyQt6; extra == "dev-pyqt6"
+Requires-Dist: pytest; extra == "dev-pyqt6"
+Requires-Dist: pytest-cov; extra == "dev-pyqt6"
 Provides-Extra: dev
+Requires-Dist: PyQt5; extra == "dev"
+Requires-Dist: PyQt5-sip; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
 Provides-Extra: docs
@@ -48,8 +63,9 @@ Dynamic: license-file
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE.md)
 [![Tests](https://github.com/davidgrier/QVideo/actions/workflows/test.yml/badge.svg)](https://github.com/davidgrier/QVideo/actions/workflows/test.yml)
 [![Documentation](https://readthedocs.org/projects/qvideo/badge/?version=latest)](https://qvideo.readthedocs.io/en/latest/)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.19239402.svg)](https://doi.org/10.5281/zenodo.19239402)
 
-**QVideo** is a framework for integrating video cameras into PyQt5 projects
+**QVideo** is a framework for integrating video cameras into PyQt projects
 for scientific research.  It provides a unified, registration-based property
 system so that every camera backend — USB webcams, GenICam devices, FLIR
 cameras, Raspberry Pi cameras — is controlled through the same API.  Property
@@ -87,16 +103,15 @@ pip install QVideo
 |---------|-------|-------|
 | GenICam cameras (Vimba, etc.) | `pip install QVideo[genicam]` | Requires a vendor-supplied `.cti` producer file |
 | Raspberry Pi camera | `pip install QVideo[picamera]` | Requires `picamera2` |
-| FLIR / Spinnaker cameras | — | Requires the proprietary PySpin SDK; install that separately |
 
 ## Quick start
 
 ```python
-from pyqtgraph.Qt import QtWidgets
+import pyqtgraph as pg
 from QVideo.cameras.Noise import QNoiseSource
 from QVideo.lib import QVideoScreen
 
-app = QtWidgets.QApplication([])
+pg.mkApp()
 
 source = QNoiseSource()          # synthetic noise — no hardware needed
 screen = QVideoScreen()
@@ -104,7 +119,7 @@ source.newFrame.connect(screen.setImage)
 
 screen.show()
 source.start()
-app.exec()
+pg.exec()
 ```
 
 Replace `QNoiseSource` with `QOpenCVSource`, `QGenicamSource`, etc. to switch

{qvideo-3.4.0 → qvideo-3.4.2}/QVideo.egg-info/SOURCES.txt

@@ -46,6 +46,7 @@ demos/__init__.py
 demos/demo.py
 demos/filterdemo.py
 demos/trackpydemo.py
+demos/yolodemo.py
 dvr/QDVRWidget.py
 dvr/QHDF5Reader.py
 dvr/QHDF5Writer.py
@@ -53,7 +54,6 @@ dvr/QOpenCVReader.py
 dvr/QOpenCVWriter.py
 dvr/__init__.py
 dvr/icons_rc.py
-dvr/icons_rc_qt6.py
 filters/Median.py
 filters/MoMedian.py
 filters/Normalize.py
@@ -126,4 +126,5 @@ tests/test_qvimbaxcamera.py
 tests/test_resolutions.py
 tests/test_roidemo.py
 tests/test_trackpy_overlay.py
-tests/test_videofilter.py
+tests/test_videofilter.py
+tests/test_yolo_overlay.py

{qvideo-3.4.0 → qvideo-3.4.2}/QVideo.egg-info/requires.txt

@@ -1,11 +1,23 @@
 h5py
 numpy
 opencv-python
-PyQt5
-PyQt5-sip
+pandas
 pyqtgraph
 
 [dev]
+PyQt5
+PyQt5-sip
+pytest
+pytest-cov
+
+[dev-pyqt5]
+PyQt5
+PyQt5-sip
+pytest
+pytest-cov
+
+[dev-pyqt6]
+PyQt6
 pytest
 pytest-cov
 
@@ -20,3 +32,10 @@ genicam
 
 [picamera]
 picamera2
+
+[pyqt5]
+PyQt5
+PyQt5-sip
+
+[pyqt6]
+PyQt6

{qvideo-3.4.0 → qvideo-3.4.2}/README.md

@@ -5,8 +5,9 @@
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE.md)
 [![Tests](https://github.com/davidgrier/QVideo/actions/workflows/test.yml/badge.svg)](https://github.com/davidgrier/QVideo/actions/workflows/test.yml)
 [![Documentation](https://readthedocs.org/projects/qvideo/badge/?version=latest)](https://qvideo.readthedocs.io/en/latest/)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.19239402.svg)](https://doi.org/10.5281/zenodo.19239402)
 
-**QVideo** is a framework for integrating video cameras into PyQt5 projects
+**QVideo** is a framework for integrating video cameras into PyQt projects
 for scientific research.  It provides a unified, registration-based property
 system so that every camera backend — USB webcams, GenICam devices, FLIR
 cameras, Raspberry Pi cameras — is controlled through the same API.  Property
@@ -44,16 +45,15 @@ pip install QVideo
 |---------|-------|-------|
 | GenICam cameras (Vimba, etc.) | `pip install QVideo[genicam]` | Requires a vendor-supplied `.cti` producer file |
 | Raspberry Pi camera | `pip install QVideo[picamera]` | Requires `picamera2` |
-| FLIR / Spinnaker cameras | — | Requires the proprietary PySpin SDK; install that separately |
 
 ## Quick start
 
 ```python
-from pyqtgraph.Qt import QtWidgets
+import pyqtgraph as pg
 from QVideo.cameras.Noise import QNoiseSource
 from QVideo.lib import QVideoScreen
 
-app = QtWidgets.QApplication([])
+pg.mkApp()
 
 source = QNoiseSource()          # synthetic noise — no hardware needed
 screen = QVideoScreen()
@@ -61,7 +61,7 @@ source.newFrame.connect(screen.setImage)
 
 screen.show()
 source.start()
-app.exec()
+pg.exec()
 ```
 
 Replace `QNoiseSource` with `QOpenCVSource`, `QGenicamSource`, etc. to switch

{qvideo-3.4.0 → qvideo-3.4.2}/demos/__init__.py

@@ -26,6 +26,11 @@ trackpydemo
     panel so that trackpy particle positions are overlaid on the live feed
     in real time and locate results are available via a signal.
 
+yolodemo
+    Extends :mod:`demo` with a :class:`~QVideo.overlays.yolo.QYoloWidget`
+    panel so that YOLO object-detection bounding boxes are overlaid on the
+    live feed in real time and detection results are available via a signal.
+
 Running
 -------
 Each demo can be launched directly::
@@ -34,6 +39,7 @@ Each demo can be launched directly::
     python -m QVideo.demos.filterdemo
     python -m QVideo.demos.ROIdemo
     python -m QVideo.demos.trackpydemo
+    python -m QVideo.demos.yolodemo
 
 Camera selection
 ----------------
@@ -66,4 +72,5 @@ from .demo import Demo
 from .filterdemo import FilterDemo
 from .ROIdemo import ROIFilter, ROIDemo
 from .trackpydemo import TrackpyDemo
+from .yolodemo import YoloDemo
 

{qvideo-3.4.0 → qvideo-3.4.2}/demos/trackpydemo.py

@@ -4,6 +4,8 @@
 Run directly::
 
     python -m QVideo.demos.trackpydemo
+
+See :mod:`QVideo.overlays.trackpy` for literature references.
 '''
 
 from QVideo.demos.demo import Demo

qvideo-3.4.2/demos/yolodemo.py

@@ -0,0 +1,61 @@
+#!/usr/bin/env python3
+'''Demo combining a live video feed, camera controls, and a YOLO overlay.
+
+Run directly::
+
+    python -m QVideo.demos.yolodemo
+
+See :mod:`QVideo.overlays.yolo` for literature references.
+'''
+
+from QVideo.demos.demo import Demo
+from QVideo.lib import QCameraTree
+from QVideo.overlays import QYoloWidget
+
+
+__all__ = ['YoloDemo']
+
+
+class YoloDemo(Demo):
+    '''Extends :class:`~QVideo.demos.demo.Demo` with a YOLO overlay.
+
+    Adds a :class:`~QVideo.overlays.yolo.QYoloWidget` control panel
+    below the camera control tree.  Detected object bounding boxes are
+    rendered in real time as a rectangle overlay on the video screen.
+
+    Parameters
+    ----------
+    cameraTree : QCameraTree
+        The camera control tree widget to display alongside the video feed.
+    model_name : str
+        YOLO model weights file passed to :class:`~QVideo.overlays.yolo.QYoloWidget`.
+        Default: ``'yolo11n.pt'``.
+    **kwargs :
+        Additional keyword arguments forwarded to :class:`~QVideo.demos.demo.Demo`.
+    '''
+
+    def __init__(self,
+                 cameraTree: QCameraTree,
+                 model_name: str = 'yolo11n.pt',
+                 **kwargs) -> None:
+        super().__init__(cameraTree, **kwargs)
+        self.yolo = QYoloWidget(self, model_name=model_name)
+        self.yolo.source = self.screen.source
+        self.yolo.attachTo(self.screen)
+        self._controls.addWidget(self.yolo)
+
+
+def main() -> None:  # pragma: no cover
+    '''Launch the YOLO demo with an interactively chosen camera.'''
+    import pyqtgraph as pg
+    from QVideo.lib import choose_camera
+
+    pg.mkQApp()
+    camera = choose_camera().start()
+    widget = YoloDemo(camera)
+    widget.show()
+    pg.exec()
+
+
+if __name__ == '__main__':  # pragma: no cover
+    main()

{qvideo-3.4.0 → qvideo-3.4.2}/filters/QYOLOFilter.py

@@ -1,4 +1,15 @@
-'''Real-time object detection with YOLO.'''
+'''Real-time object detection with YOLO.
+
+References
+----------
+.. [1] Jocher, G., Chaurasia, A., & Qiu, J. (2023). Ultralytics YOLO.
+   https://github.com/ultralytics/ultralytics
+
+.. [2] Redmon, J., Divvala, S., Girshick, R., & Farhadi, A. (2016).
+   You only look once: Unified, real-time object detection.
+   Proceedings of the IEEE Conference on Computer Vision and Pattern
+   Recognition, 779-788. https://doi.org/10.1109/CVPR.2016.91
+'''
 
 from pyqtgraph.Qt import QtCore, QtWidgets
 from QVideo.lib.QVideoFilter import VideoFilter, QVideoFilter

{qvideo-3.4.0 → 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.0 → qvideo-3.4.2}/overlays/__init__.py

@@ -1,5 +1,6 @@
 '''Graphical overlays for :class:`~QVideo.lib.QVideoScreen.QVideoScreen`.'''
 
 from .trackpy import QTrackpyOverlay, QTrackpyWidget
+from .yolo import QYoloOverlay, QYoloWidget
 
-__all__ = ['QTrackpyOverlay', 'QTrackpyWidget']
+__all__ = ['QTrackpyOverlay', 'QTrackpyWidget', 'QYoloOverlay', 'QYoloWidget']

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

@@ -1,4 +1,15 @@
-'''Real-time particle tracking overlay using trackpy.'''
+'''Real-time particle tracking overlay using trackpy.
+
+References
+----------
+Allan, D. B., Caswell, T., Keim, N. C., van der Wel, C. M., &
+Verweij, R. W. trackpy: Fast, Friendly Particle Tracking in Python.
+Zenodo. https://doi.org/10.5281/zenodo.9971
+
+Crocker, J. C., & Grier, D. G. (1996). Methods of digital video
+microscopy for colloidal studies. Journal of Colloid and Interface
+Science, 179(1), 298-310. https://doi.org/10.1006/jcis.1996.0217
+'''
 
 from pyqtgraph.Qt import QtCore, QtGui, QtWidgets
 import pyqtgraph as pg
@@ -133,14 +144,10 @@ class QTrackpyWidget(QtWidgets.QGroupBox):
     minmass : float
         Initial minimum integrated brightness. Default: ``100``.
 
-    Signals
-    -------
-    newData(object)
-        Emitted for each processed frame with the
-        :func:`trackpy.locate` :class:`~pandas.DataFrame`
-        (or ``None`` on error).
     '''
 
+    #: Emitted for each processed frame with the :func:`trackpy.locate`
+    #: :class:`~pandas.DataFrame`, or ``None`` on error.
     newData = QtCore.pyqtSignal(object)
     _locate = QtCore.pyqtSignal(np.ndarray)
 
@@ -203,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.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.view.addItem(self._overlay)
+        screen.removeOverlay(self._overlay)
 
     @QtCore.pyqtSlot(np.ndarray)
     def _onNewFrame(self, image: Image) -> None: