[libcamera-devel,v3,06/19] ipa: ipu3: awb: Reword accumulator documentation

14272 diff mbox series

Now that we moved the diagram into the AWB class documentation, reword the
accumulator documentation to make it clear it is not meant to be used
only in AWB.

Signed-off-by: Jean-Michel Hautbois <jeanmichel.hautbois@ideasonboard.com>
---
 src/ipa/ipu3/algorithms/awb.cpp | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Quoting Jean-Michel Hautbois (2021-10-22 16:12:05)
> Now that we moved the diagram into the AWB class documentation, reword the
> accumulator documentation to make it clear it is not meant to be used
> only in AWB.
> 
> Signed-off-by: Jean-Michel Hautbois <jeanmichel.hautbois@ideasonboard.com>
> ---
>  src/ipa/ipu3/algorithms/awb.cpp | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/src/ipa/ipu3/algorithms/awb.cpp b/src/ipa/ipu3/algorithms/awb.cpp
> index 7e10460f..101d84ca 100644
> --- a/src/ipa/ipu3/algorithms/awb.cpp
> +++ b/src/ipa/ipu3/algorithms/awb.cpp
> @@ -46,9 +46,9 @@ static constexpr uint32_t kMinCellsPerZoneRatio = 255 * 90 / 100;
>   * \struct Accumulator
>   * \brief RGB statistics for a given zone
>   *
> - * The Accumulator structure stores the sum of the average of each cell in a
> - * zone of the image, as well as the number of cells which were unsaturated and
> - * therefore included in the average.
> + * Accumulate red, green and blue values for each non-saturated items over a

s/items/item/

> + * zone. Items can for instance be pixels, but also the average of groups of
> + * pixels, depending on who uses the accumulator.
>   * \todo move this description and structure into a common header
>   *
>   * Cells which are saturated beyond the threshold defined in

Are these 'cells' references still valid here too?

> -- 
> 2.32.0
>

On Mon, Oct 25, 2021 at 09:15:03PM +0100, Kieran Bingham wrote:
> Quoting Jean-Michel Hautbois (2021-10-22 16:12:05)
> > Now that we moved the diagram into the AWB class documentation, reword the
> > accumulator documentation to make it clear it is not meant to be used
> > only in AWB.
> > 
> > Signed-off-by: Jean-Michel Hautbois <jeanmichel.hautbois@ideasonboard.com>
> > ---
> >  src/ipa/ipu3/algorithms/awb.cpp | 6 +++---
> >  1 file changed, 3 insertions(+), 3 deletions(-)
> > 
> > diff --git a/src/ipa/ipu3/algorithms/awb.cpp b/src/ipa/ipu3/algorithms/awb.cpp
> > index 7e10460f..101d84ca 100644
> > --- a/src/ipa/ipu3/algorithms/awb.cpp
> > +++ b/src/ipa/ipu3/algorithms/awb.cpp
> > @@ -46,9 +46,9 @@ static constexpr uint32_t kMinCellsPerZoneRatio = 255 * 90 / 100;
> >   * \struct Accumulator
> >   * \brief RGB statistics for a given zone
> >   *
> > - * The Accumulator structure stores the sum of the average of each cell in a
> > - * zone of the image, as well as the number of cells which were unsaturated and
> > - * therefore included in the average.
> > + * Accumulate red, green and blue values for each non-saturated items over a
> 
> s/items/item/
> 
> > + * zone. Items can for instance be pixels, but also the average of groups of
> > + * pixels, depending on who uses the accumulator.
> >   * \todo move this description and structure into a common header
> >   *
> >   * Cells which are saturated beyond the threshold defined in
> 
> Are these 'cells' references still valid here too?

I think this should now be zones.

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>