diff options
| author | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2023-06-02 08:40:16 +0300 |
|---|---|---|
| committer | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2023-06-05 20:00:02 +0300 |
| commit | f65a73f3c8fd3f4d1ca51f537b97b97eaab59bf6 (patch) | |
| tree | 79fff7eec375eab136965bb27ad0a20da2305058 /src/libcamera/control_ids.yaml | |
| parent | a0271e72a86da5796891795565f43f20f7024a8d (diff) | |
libcamera: controls: Drop reference to IPA in controls documentation
The controls relates to the public API, which doesn't expose IPA modules
as they are internal to libcamera. Replace the mention of "IPA" in the
controls documentation.
While at it, fix a small text reflow issue.
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Naushir Patuck <naush@raspberrypi.com>
Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
Diffstat (limited to 'src/libcamera/control_ids.yaml')
| -rw-r--r-- | src/libcamera/control_ids.yaml | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/src/libcamera/control_ids.yaml b/src/libcamera/control_ids.yaml index adea5f90..a0fbb772 100644 --- a/src/libcamera/control_ids.yaml +++ b/src/libcamera/control_ids.yaml @@ -275,12 +275,12 @@ controls: type: int32_t description: | Reports a Figure of Merit (FoM) to indicate how in-focus the frame is. - A larger FocusFoM value indicates a more in-focus frame. This control - depends on the IPA to gather ISP statistics from the defined focus - region, and combine them in a suitable way to generate a FocusFoM value. - In this respect, it is not necessarily aimed at providing a way to - implement a focus algorithm by the application, rather an indication of - how in-focus a frame is. + A larger FocusFoM value indicates a more in-focus frame. This singular + value may be based on a combination of statistics gathered from + multiple focus regions within an image. The number of focus regions and + method of combination is platform dependent. In this respect, it is not + necessarily aimed at providing a way to implement a focus algorithm by + the application, rather an indication of how in-focus a frame is. - ColourCorrectionMatrix: type: float @@ -333,8 +333,8 @@ controls: - FrameDurationLimits: type: int64_t description: | - The minimum and maximum (in that order) frame duration, - expressed in microseconds. + The minimum and maximum (in that order) frame duration, expressed in + microseconds. When provided by applications, the control specifies the sensor frame duration interval the pipeline has to use. This limits the largest @@ -343,7 +343,7 @@ controls: the sensor will not be able to raise the exposure time above 33ms. A fixed frame duration is achieved by setting the minimum and maximum values to be the same. Setting both values to 0 reverts to using the - IPA provided defaults. + camera defaults. The maximum frame duration provides the absolute limit to the shutter speed computed by the AE algorithm and it overrides any exposure mode |