libcamera/utils/tuning
Laurent Pinchart d0478c41f4 libcamera: Rename "shutter speed" to "exposure time"
The terms "shutter" and "shutter speed" are used through libcamera to
mean "exposure time". This is confusing, both due to "speed" being used
as "time" while it should be the inverse (i.e. a maximum speed should
correspond to the minimum time), and due to "shutter speed" and
"exposure time" being used in different places with the same meaning.

To improve clarity of the code base and the documentation, use "exposure
time" consistently to replace "shutter speed".

This rename highlighted another vocabulary issue in libcamera. The
ExposureModeHelper::splitExposure() function used to document that it
splits "exposure time into shutter time and gain". It has been reworded
to "split exposure into exposure time and gain". That is not entirely
satisfactory, as "exposure" has a defined meaning in photography (see
https://en.wikipedia.org/wiki/Exposure_(photography)) that is not
expressed as a duration. This issue if left to be addressed separately.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Naushir Patuck <naush@raspberrypi.com>
Acked-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
2024-11-26 19:05:17 +02:00
..
libtuning libcamera: Rename "shutter speed" to "exposure time" 2024-11-26 19:05:17 +02:00
raspberrypi libcamera: Drop file name from header comment blocks 2024-05-08 22:39:50 +03:00
config-example.yaml libtuning: Implement a minimal yaml parser 2024-07-05 22:38:16 +02:00
raspberrypi_alsc_only.py libcamera: Drop file name from header comment blocks 2024-05-08 22:39:50 +03:00
README.rst utils: tuning: Add requirements file and update readme 2024-07-05 12:45:10 +02:00
requirements.txt libtuning: Migrate prints to python logging framework 2024-07-05 22:38:00 +02:00
rkisp1.py utils: tuning: Change Tuner.add() to accept a list of modules 2024-08-14 16:22:07 +02:00

.. SPDX-License-Identifier: CC-BY-SA-4.0

libcamera tuning tools
======================

.. Note:: The tuning tools are still very much work in progress. If in doubt,
    please ask on the mailing list.

.. todo::
    Write documentation

Installation of dependencies
----------------------------

::
    # Using a venv
    python3 -m venv venv
    . ./venv/bin/activate
    pip3 install -r requirements.txt