[v3,28/35] ipa: libipa: lsc: Document LscDescriptor::sensorSize usage
diff mbox series

Message ID 20260706-libipa-algorithms-v3-28-968757b038bb@ideasonboard.com
State New
Headers show
Series
  • ipa: libipa: Introduce libipa algorithms
Related show

Commit Message

Jacopo Mondi July 6, 2026, 8:01 a.m. UTC 
Now that sensorSize_ has been removed from LscPolynomial and is
passed to the Lsc algorithm through LscDescriptor document its intended
purpose.

Signed-off-by: Jacopo Mondi <jacopo.mondi@ideasonboard.com>
---
 src/ipa/libipa/lsc.cpp | 4 ++++
 1 file changed, 4 insertions(+)

Patch
diff mbox series 

diff --git a/src/ipa/libipa/lsc.cpp b/src/ipa/libipa/lsc.cpp
index 804bbc2915e4..c1207292518a 100644
--- a/src/ipa/libipa/lsc.cpp
+++ b/src/ipa/libipa/lsc.cpp
@@ -179,6 +179,10 @@  namespace lsc {
  *          k4: 0.0
  * \endcode
  *
+ * The lsc tables or the polynomial definition are generated at tuning time
+ * using an image of known resolution which needs to be specified in
+ * LscDescriptor::sensorSize.
+ *
  * At LscAlgorithm::configure() time the lsc tables are re-sampled on the
  * sensor's crop rectangle in use to adapt them to the configuration in use for
  * a streaming session. Polynomial lsc tables support re-sampling and can be