[v2,09/10] ipa: simple: data: Document tuning parameters in uncalibrated.yaml
diff mbox series

Message ID 20260506230722.1041596-10-devve.3@gmail.com
State New
Headers show
Series
  • OV01A10 sensor support and simple IPA improvements
Related show

Commit Message

devve May 6, 2026, 11:07 p.m. UTC 
Add comments documenting all algorithm YAML keys (BlackLevel, Awb,
Ccm, Adjust, Agc) to the uncalibrated template so sensor calibration
authors can discover parameters without reading source code.
Update ov01a10.yaml replacing stepDenominator (removed) with
proportionalGain for the new proportional AGC controller.

Signed-off-by: d3vv3 <devve.3@gmail.com>
---
 src/ipa/simple/data/ov01a10.yaml      |  2 +-
 src/ipa/simple/data/uncalibrated.yaml | 40 +++++++++++++++++++++++----
 2 files changed, 35 insertions(+), 7 deletions(-)

Comments

Milan Zamazal May 11, 2026, 11:12 a.m. UTC | #1 
d3vv3 <devve.3@gmail.com> writes:

> Add comments documenting all algorithm YAML keys (BlackLevel, Awb,
> Ccm, Adjust, Agc) to the uncalibrated template so sensor calibration
> authors can discover parameters without reading source code.
> Update ov01a10.yaml replacing stepDenominator (removed) with
> proportionalGain for the new proportional AGC controller.

This should be a separate patch.

> Signed-off-by: d3vv3 <devve.3@gmail.com>
> ---
>  src/ipa/simple/data/ov01a10.yaml      |  2 +-
>  src/ipa/simple/data/uncalibrated.yaml | 40 +++++++++++++++++++++++----
>  2 files changed, 35 insertions(+), 7 deletions(-)
>
> diff --git a/src/ipa/simple/data/ov01a10.yaml b/src/ipa/simple/data/ov01a10.yaml
> index d1f613c5..9663c6da 100644
> --- a/src/ipa/simple/data/ov01a10.yaml
> +++ b/src/ipa/simple/data/ov01a10.yaml
> @@ -51,5 +51,5 @@ algorithms:
>    - Agc:
>        exposureTarget: 2.5
>        hysteresis: 0.2
> -      stepDenominator: 20
> +      proportionalGain: 0.04
>  ...
> diff --git a/src/ipa/simple/data/uncalibrated.yaml b/src/ipa/simple/data/uncalibrated.yaml
> index fc90ca52..7391c36e 100644
> --- a/src/ipa/simple/data/uncalibrated.yaml
> +++ b/src/ipa/simple/data/uncalibrated.yaml
> @@ -3,17 +3,45 @@
>  ---
>  version: 1
>  algorithms:
> +  # --- Black Level ---
> +  # blackLevel: 16-bit black level pedestal (optional).
> +  #   If omitted, auto-detected from histogram dark end.

Or taken from the camera sensor helper if provided.

>    - BlackLevel:
> +
> +  # --- Auto White Balance ---
> +  # maxGainR: Maximum red channel gain (default 4.0).
> +  # maxGainB: Maximum blue channel gain (default 4.0).
> +  # speed: Temporal smoothing factor 0-1 (default 1.0 = instant).
> +  #   0.25 = slow smooth, 0.5 = moderate, 1.0 = no smoothing.
>    - Awb:
> -  # Color correction matrices can be defined here. The CCM algorithm
> -  # has a significant performance impact, and should only be enabled
> -  # if tuned.
> +
> +  # --- Color Correction Matrix ---
> +  # Has a significant performance impact on the CPU ISP, and should
> +  # only be enabled if tuned. Provide ccms as a list of color temperature
> +  # entries with a 3x3 matrix:
>    # - Ccm:
>    #     ccms:
>    #       - ct: 6500
> -  #         ccm: [ 1, 0, 0,
> -  #                0, 1, 0,
> -  #                0, 0, 1]
> +  #         ccm: [ 1.0,  0.0,  0.0,
> +  #                0.0,  1.0,  0.0,
> +  #                0.0,  0.0,  1.0 ]
> +  # - Ccm:
> +
> +  # --- Image Adjustments ---
> +  # gamma: Gamma encoding value (default 2.2, range 0.1-10.0).
> +  # contrast: Contrast scaling (default 1.0, range 0.0-2.0).
> +  # saturation: Saturation multiplier (default 1.0, range 0.0-2.0).
> +  #   Only active when CCM is enabled.
>    - Adjust:
> +
> +  # --- Auto Gain/Exposure Control (proportional) ---
> +  # exposureTarget: Target MSV (mean sample value) in histogram bins.
> +  #   Default: 2.5 (middle of 5-bin range).
> +  #   Lower values target a darker exposure.
> +  # hysteresis: Deadband around target where no adjustment occurs.
> +  #   Default 0.2. Larger values reduce sensitivity near target.
> +  # proportionalGain: Step scaling factor (default 0.04).
> +  #   At max error (~2.5): factor 1.10 (~10% step).
> +  #   Near target: factor ~1.01 (~1% step).

I think the proportionalGain description should be a bit clarified.
It's not clear whether the given values are applied for the default
value and why the default factor is 0.04 while the other factor values
are > 1.0.

>    - Agc:
>  ...

Patch
diff mbox series 

diff --git a/src/ipa/simple/data/ov01a10.yaml b/src/ipa/simple/data/ov01a10.yaml
index d1f613c5..9663c6da 100644
--- a/src/ipa/simple/data/ov01a10.yaml
+++ b/src/ipa/simple/data/ov01a10.yaml
@@ -51,5 +51,5 @@  algorithms:
   - Agc:
       exposureTarget: 2.5
       hysteresis: 0.2
-      stepDenominator: 20
+      proportionalGain: 0.04
 ...
diff --git a/src/ipa/simple/data/uncalibrated.yaml b/src/ipa/simple/data/uncalibrated.yaml
index fc90ca52..7391c36e 100644
--- a/src/ipa/simple/data/uncalibrated.yaml
+++ b/src/ipa/simple/data/uncalibrated.yaml
@@ -3,17 +3,45 @@ 
 ---
 version: 1
 algorithms:
+  # --- Black Level ---
+  # blackLevel: 16-bit black level pedestal (optional).
+  #   If omitted, auto-detected from histogram dark end.
   - BlackLevel:
+
+  # --- Auto White Balance ---
+  # maxGainR: Maximum red channel gain (default 4.0).
+  # maxGainB: Maximum blue channel gain (default 4.0).
+  # speed: Temporal smoothing factor 0-1 (default 1.0 = instant).
+  #   0.25 = slow smooth, 0.5 = moderate, 1.0 = no smoothing.
   - Awb:
-  # Color correction matrices can be defined here. The CCM algorithm
-  # has a significant performance impact, and should only be enabled
-  # if tuned.
+
+  # --- Color Correction Matrix ---
+  # Has a significant performance impact on the CPU ISP, and should
+  # only be enabled if tuned. Provide ccms as a list of color temperature
+  # entries with a 3x3 matrix:
   # - Ccm:
   #     ccms:
   #       - ct: 6500
-  #         ccm: [ 1, 0, 0,
-  #                0, 1, 0,
-  #                0, 0, 1]
+  #         ccm: [ 1.0,  0.0,  0.0,
+  #                0.0,  1.0,  0.0,
+  #                0.0,  0.0,  1.0 ]
+  # - Ccm:
+
+  # --- Image Adjustments ---
+  # gamma: Gamma encoding value (default 2.2, range 0.1-10.0).
+  # contrast: Contrast scaling (default 1.0, range 0.0-2.0).
+  # saturation: Saturation multiplier (default 1.0, range 0.0-2.0).
+  #   Only active when CCM is enabled.
   - Adjust:
+
+  # --- Auto Gain/Exposure Control (proportional) ---
+  # exposureTarget: Target MSV (mean sample value) in histogram bins.
+  #   Default: 2.5 (middle of 5-bin range).
+  #   Lower values target a darker exposure.
+  # hysteresis: Deadband around target where no adjustment occurs.
+  #   Default 0.2. Larger values reduce sensitivity near target.
+  # proportionalGain: Step scaling factor (default 0.04).
+  #   At max error (~2.5): factor 1.10 (~10% step).
+  #   Near target: factor ~1.01 (~1% step).
   - Agc:
 ...