Skip to content

docs: explain live_mode_available and hardware_averaging in CameraBase #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
seb5g merged 1 commit into from
Oct 27, 2026
Merged

docs: explain live_mode_available and hardware_averaging in CameraBase #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/pymodaq_plugins_utils/hardware/camera_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,11 +130,18 @@ class CameraBase(DAQ_Viewer_base):
The camera driver (``self.controller``, created in :meth:`ini_detector_custom`) follows
:class:`~pymodaq_plugins_utils.hardware.camera_driver.CameraDriverBase`. If its ``get_pixel_size`` method returns
a size, the axes of the viewer are in micrometers, otherwise in pixels.

``live_mode_available`` and ``hardware_averaging`` are independent (see the *Live Mode* section of the PyMoDAQ
documentation): in live mode the viewer calls ``grab_data`` once and the camera thread emits the frames until
``stop`` is called, and ``hardware_averaging`` tells who averages the frames.
"""
params = comon_parameters + cam_params

callback_signal = QtCore.Signal(Grab)
live_mode_available = True
# The camera thread already averages Naverage frames (Grab.n_average): once the pymodaq releases that contain the fix
# of the live mode (PyMoDAQ #1421) are the minimum required, this should be True, otherwise the viewer averages
# the averaged frames a second time.
hardware_averaging = False

def ini_attributes(self):
Expand Down
Loading