{"id":20342,"url":"https://patchwork.libcamera.org/api/1.1/patches/20342/?format=json","web_url":"https://patchwork.libcamera.org/patch/20342/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/1.1/projects/1/?format=json","name":"libcamera","link_name":"libcamera","list_id":"libcamera_core","list_email":"libcamera-devel@lists.libcamera.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20240616174541.10708-2-laurent.pinchart@ideasonboard.com>","date":"2024-06-16T17:45:38","name":"[v10,1/4] ipa: libipa: Add Matrix class","commit_ref":"f191c10fe180fefac418fa41a3c49f5b18f9a3d7","pull_url":null,"state":"accepted","archived":false,"hash":"da38bc04ed4e8f8536d9aec14efa6f0223192c5f","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/1.1/people/2/?format=json","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/20342/mbox/","series":[{"id":4401,"url":"https://patchwork.libcamera.org/api/1.1/series/4401/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=4401","date":"2024-06-16T17:45:37","name":"ipa: rkisp1: Add crosstalk algorithm","version":10,"mbox":"https://patchwork.libcamera.org/series/4401/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/20342/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/20342/checks/","tags":{},"headers":{"Return-Path":"","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id 4A9DEC3293\n\tfor ;\n\tSun, 16 Jun 2024 17:46:09 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 7CF5E65493;\n\tSun, 16 Jun 2024 19:46:08 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 12CBE65456\n\tfor ;\n\tSun, 16 Jun 2024 19:46:05 +0200 (CEST)","from pendragon.ideasonboard.com (81-175-209-231.bb.dnainternet.fi\n\t[81.175.209.231])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id E7BB02D5;\n\tSun, 16 Jun 2024 19:45:47 +0200 (CEST)"],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"v5ZZFtMe\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1718559948;\n\tbh=P0nSlFwrhwM8Ai3dKZjNHH17pbH7p/amKaROnHiC2JE=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=v5ZZFtMeqDgLh0dwsz1h73LkRXr9ynSjuS3+D0iQsKzKrlU92kL6BKBhx8dT3meN/\n\tzx7MKf/5Kn88Ba8Tt3yzMFg38iMbpMgQBctoYk4ml5NzGCQJXKjAYoqvuPiBA9lM1x\n\tUaJVerX//xls4ilod57PUK8eKTf0N6lSFVbvzoS8=","From":"Laurent Pinchart ","To":"libcamera-devel@lists.libcamera.org","Cc":"Paul Elder ","Subject":"[PATCH v10 1/4] ipa: libipa: Add Matrix class","Date":"Sun, 16 Jun 2024 20:45:38 +0300","Message-ID":"<20240616174541.10708-2-laurent.pinchart@ideasonboard.com>","X-Mailer":"git-send-email 2.44.2","In-Reply-To":"<20240616174541.10708-1-laurent.pinchart@ideasonboard.com>","References":"<20240616174541.10708-1-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "},"content":"From: Paul Elder \n\nAdd a class to represent a Matrix object and operations for adding\nmatrices, multipling a matrix by a scalar, and multiplying two matrices.\n\nSigned-off-by: Paul Elder \nReviewed-by: Stefan Klug \nReviewed-by: Kieran Bingham \nReviewed-by: Laurent Pinchart \nSigned-off-by: Laurent Pinchart \n---\nChanges since v9:\n\n- Add missing curly braces\n- Drop unneeded __DOXYGEN__ guard\n- Replace R and C with Rows and Cols where missing\n- Add missing () in \\fn\n- Minor docs improvements\n\nNo change in v9\n\nChanges in v8:\n- remove readYaml and replace with yaml get\n - which makes this patch depend on \"ipa: libipa: Vector and Pwl\n improvements\"\n- make default constructor make a zero matrix, and add an identity()\n static function\n- add operator*=\n- add operator* for reverse order of scalar-matrix product\n- s/\\/Rows/g, s/\\/Cols/g\n\nChanges in v7:\n- fix copyright and license\n\nChanges in v6:\n- fix doxygen\n\nChanges in v5:\n- add documentation\n\nChanges in v4:\n- remove stray semicolons\n- add operator<<\n- clean up/optimize constructor\n- replace get() and set() with operator[] (and a second [] can be used\n as operator[] returns a Span)\n\nChanges in v3:\n- fix template parameters of operator* to allow different types for the\n scalar multiplier and the matrix's number type\n- clear data in constructors\n- fix assert in constructor\n\nChanges v2:\n- make rows and columns into template arguments\n- initialize to identity matrix on construction\n- add getter and setter\n- change from struct to class\n- fix matrix multiplication\n- clean up unused includes\n- avoid dereferencing an absent std::optional\n---\n src/ipa/libipa/matrix.cpp | 149 +++++++++++++++++++++++++++\n src/ipa/libipa/matrix.h | 204 +++++++++++++++++++++++++++++++++++++\n src/ipa/libipa/meson.build | 2 +\n 3 files changed, 355 insertions(+)\n create mode 100644 src/ipa/libipa/matrix.cpp\n create mode 100644 src/ipa/libipa/matrix.h","diff":"diff --git a/src/ipa/libipa/matrix.cpp b/src/ipa/libipa/matrix.cpp\nnew file mode 100644\nindex 000000000000..7f000382d33b\n--- /dev/null\n+++ b/src/ipa/libipa/matrix.cpp\n@@ -0,0 +1,149 @@\n+/* SPDX-License-Identifier: LGPL-2.1-or-later */\n+/*\n+ * Copyright (C) 2024, Paul Elder \n+ *\n+ * Matrix and related operations\n+ */\n+\n+#include \"matrix.h\"\n+\n+#include \n+\n+/**\n+ * \\file matrix.h\n+ * \\brief Matrix class\n+ */\n+\n+namespace libcamera {\n+\n+LOG_DEFINE_CATEGORY(Matrix)\n+\n+namespace ipa {\n+\n+/**\n+ * \\class Matrix\n+ * \\brief Matrix class\n+ * \\tparam T Type of numerical values to be stored in the matrix\n+ * \\tparam Rows Number of rows in the matrix\n+ * \\tparam Cols Number of columns in the matrix\n+ */\n+\n+/**\n+ * \\fn Matrix::Matrix()\n+ * \\brief Construct a zero matrix\n+ */\n+\n+/**\n+ * \\fn Matrix::Matrix(const std::vector &data)\n+ * \\brief Construct a matrix from supplied data\n+ * \\param[in] data Data from which to construct a matrix\n+ *\n+ * \\a data is a one-dimensional vector and will be turned into a matrix in\n+ * row-major order. The size of \\a data must be equal to the product of the\n+ * number of rows and columns of the matrix (Rows x Cols).\n+ */\n+\n+/**\n+ * \\fn Matrix::identity()\n+ * \\brief Construct an identity matrix\n+ */\n+\n+/**\n+ * \\fn Matrix::toString()\n+ * \\brief Assemble and return a string describing the matrix\n+ * \\return A string describing the matrix\n+ */\n+\n+/**\n+ * \\fn Span Matrix::operator[](size_t i) const\n+ * \\brief Index to a row in the matrix\n+ * \\param[in] i Index of row to retrieve\n+ *\n+ * This operator[] returns a Span, which can then be indexed into again with\n+ * another operator[], allowing a convenient m[i][j] to access elements of the\n+ * matrix. Note that the lifetime of the Span returned by this first-level\n+ * operator[] is bound to that of the Matrix itself, so it is not recommended\n+ * to save the Span that is the result of this operator[].\n+ *\n+ * \\return Row \\a i from the matrix, as a Span\n+ */\n+\n+/**\n+ * \\fn Matrix::operator[](size_t i)\n+ * \\copydoc Matrix::operator[](size_t i) const\n+ */\n+\n+/**\n+ * \\fn Matrix &Matrix::operator*=(U d)\n+ * \\brief Multiply the matrix by a scalar in-place\n+ * \\tparam U Type of the numerical scalar value\n+ * \\param d The scalar multiplier\n+ * \\return Product of this matrix and scalar \\a d\n+ */\n+\n+/**\n+ * \\fn Matrix::Matrix operator*(T d, const Matrix &m)\n+ * \\brief Multiply the matrix by a scalar\n+ * \\tparam T Type of the numerical scalar value\n+ * \\tparam U Type of numerical values in the matrix\n+ * \\tparam Rows Number of rows in the matrix\n+ * \\tparam Cols Number of columns in the matrix\n+ * \\param d The scalar multiplier\n+ * \\param m The matrix\n+ * \\return Product of scalar \\a d and matrix \\a m\n+ */\n+\n+/**\n+ * \\fn Matrix::Matrix operator*(const Matrix &m, T d)\n+ * \\copydoc operator*(T d, const Matrix &m)\n+ */\n+\n+/**\n+ * \\fn Matrix operator*(const Matrix &m1, const Matrix &m2)\n+ * \\brief Matrix multiplication\n+ * \\tparam T Type of numerical values in the matrices\n+ * \\tparam R1 Number of rows in the first matrix\n+ * \\tparam C1 Number of columns in the first matrix\n+ * \\tparam R2 Number of rows in the second matrix\n+ * \\tparam C2 Number of columns in the second matrix\n+ * \\param m1 Multiplicand matrix\n+ * \\param m2 Multiplier matrix\n+ * \\return Matrix product of matrices \\a m1 and \\a m2\n+ */\n+\n+/**\n+ * \\fn Matrix operator+(const Matrix &m1, const Matrix &m2)\n+ * \\brief Matrix addition\n+ * \\tparam T Type of numerical values in the matrices\n+ * \\tparam Rows Number of rows in the matrices\n+ * \\tparam Cols Number of columns in the matrices\n+ * \\param m1 Summand matrix\n+ * \\param m2 Summand matrix\n+ * \\return Matrix sum of matrices \\a m1 and \\a m2\n+ */\n+\n+} /* namespace ipa */\n+\n+#ifndef __DOXYGEN__\n+/*\n+ * The YAML data shall be a list of numerical values. Its size shall be equal\n+ * to the product of the number of rows and columns of the matrix (Rows x\n+ * Cols). The values shall be stored in row-major order.\n+ */\n+bool matrixValidateYaml(const YamlObject &obj, unsigned int size)\n+{\n+\tif (!obj.isList())\n+\t\treturn false;\n+\n+\tif (obj.size() != size) {\n+\t\tLOG(Matrix, Error)\n+\t\t\t<< \"Wrong number of values in matrix: expected \"\n+\t\t\t<< size << \", got \" << obj.size();\n+\t\treturn false;\n+\t}\n+\n+\treturn true;\n+}\n+#endif /* __DOXYGEN__ */\n+\n+} /* namespace libcamera */\ndiff --git a/src/ipa/libipa/matrix.h b/src/ipa/libipa/matrix.h\nnew file mode 100644\nindex 000000000000..8aa8f3438caa\n--- /dev/null\n+++ b/src/ipa/libipa/matrix.h\n@@ -0,0 +1,204 @@\n+/* SPDX-License-Identifier: LGPL-2.1-or-later */\n+/*\n+ * Copyright (C) 2024, Paul Elder \n+ *\n+ * Matrix and related operations\n+ */\n+#pragma once\n+\n+#include \n+#include \n+#include \n+#include \n+\n+#include \n+#include \n+\n+#include \"libcamera/internal/yaml_parser.h\"\n+\n+namespace libcamera {\n+\n+LOG_DECLARE_CATEGORY(Matrix)\n+\n+namespace ipa {\n+\n+#ifndef __DOXYGEN__\n+template> * = nullptr>\n+#else\n+template\n+#endif /* __DOXYGEN__ */\n+class Matrix\n+{\n+public:\n+\tMatrix()\n+\t{\n+\t\tdata_.fill(static_cast(0));\n+\t}\n+\n+\tMatrix(const std::vector &data)\n+\t{\n+\t\tstd::copy(data.begin(), data.end(), data_.begin());\n+\t}\n+\n+\tstatic Matrix identity()\n+\t{\n+\t\tMatrix ret;\n+\t\tfor (size_t i = 0; i < std::min(Rows, Cols); i++)\n+\t\t\tret[i][i] = static_cast(1);\n+\t\treturn ret;\n+\t}\n+\n+\t~Matrix() = default;\n+\n+\tconst std::string toString() const\n+\t{\n+\t\tstd::stringstream out;\n+\n+\t\tout << \"Matrix { \";\n+\t\tfor (unsigned int i = 0; i < Rows; i++) {\n+\t\t\tout << \"[ \";\n+\t\t\tfor (unsigned int j = 0; j < Cols; j++) {\n+\t\t\t\tout << (*this)[i][j];\n+\t\t\t\tout << ((j + 1 < Cols) ? \", \" : \" \");\n+\t\t\t}\n+\t\t\tout << ((i + 1 < Rows) ? \"], \" : \"]\");\n+\t\t}\n+\t\tout << \" }\";\n+\n+\t\treturn out.str();\n+\t}\n+\n+\tSpan operator[](size_t i) const\n+\t{\n+\t\treturn Span{ &data_.data()[i * Cols], Cols };\n+\t}\n+\n+\tSpan operator[](size_t i)\n+\t{\n+\t\treturn Span{ &data_.data()[i * Cols], Cols };\n+\t}\n+\n+#ifndef __DOXYGEN__\n+\ttemplate>>\n+#else\n+\ttemplate\n+#endif /* __DOXYGEN__ */\n+\tMatrix &operator*=(U d)\n+\t{\n+\t\tfor (unsigned int i = 0; i < Rows * Cols; i++)\n+\t\t\tdata_[i] *= d;\n+\t\treturn *this;\n+\t}\n+\n+private:\n+\tstd::array data_;\n+};\n+\n+#ifndef __DOXYGEN__\n+template> * = nullptr>\n+#else\n+template\n+#endif /* __DOXYGEN__ */\n+Matrix operator*(T d, const Matrix &m)\n+{\n+\tMatrix result;\n+\n+\tfor (unsigned int i = 0; i < Rows; i++) {\n+\t\tfor (unsigned int j = 0; j < Cols; j++)\n+\t\t\tresult[i][j] = d * m[i][j];\n+\t}\n+\n+\treturn result;\n+}\n+\n+#ifndef __DOXYGEN__\n+template> * = nullptr>\n+#else\n+template\n+#endif /* __DOXYGEN__ */\n+Matrix operator*(const Matrix &m, T d)\n+{\n+\treturn d * m;\n+}\n+\n+#ifndef __DOXYGEN__\n+template * = nullptr>\n+#else\n+template\n+#endif /* __DOXYGEN__ */\n+Matrix operator*(const Matrix &m1, const Matrix &m2)\n+{\n+\tMatrix result;\n+\n+\tfor (unsigned int i = 0; i < R1; i++) {\n+\t\tfor (unsigned int j = 0; j < C2; j++) {\n+\t\t\tT sum = 0;\n+\n+\t\t\tfor (unsigned int k = 0; k < C1; k++)\n+\t\t\t\tsum += m1[i][k] * m2[k][j];\n+\n+\t\t\tresult[i][j] = sum;\n+\t\t}\n+\t}\n+\n+\treturn result;\n+}\n+\n+template\n+Matrix operator+(const Matrix &m1, const Matrix &m2)\n+{\n+\tMatrix result;\n+\n+\tfor (unsigned int i = 0; i < Rows; i++) {\n+\t\tfor (unsigned int j = 0; j < Cols; j++)\n+\t\t\tresult[i][j] = m1[i][j] + m2[i][j];\n+\t}\n+\n+\treturn result;\n+}\n+\n+#ifndef __DOXYGEN__\n+bool matrixValidateYaml(const YamlObject &obj, unsigned int size);\n+#endif /* __DOXYGEN__ */\n+\n+} /* namespace ipa */\n+\n+#ifndef __DOXYGEN__\n+template\n+std::ostream &operator<<(std::ostream &out, const ipa::Matrix &m)\n+{\n+\tout << m.toString();\n+\treturn out;\n+}\n+\n+template\n+struct YamlObject::Getter> {\n+\tstd::optional> get(const YamlObject &obj) const\n+\t{\n+\t\tif (!ipa::matrixValidateYaml(obj, Rows * Cols))\n+\t\t\treturn std::nullopt;\n+\n+\t\tipa::Matrix matrix;\n+\t\tT *data = &matrix[0][0];\n+\n+\t\tunsigned int i = 0;\n+\t\tfor (const YamlObject &entry : obj.asList()) {\n+\t\t\tconst auto value = entry.get();\n+\t\t\tif (!value)\n+\t\t\t\treturn std::nullopt;\n+\n+\t\t\tdata[i++] = *value;\n+\t\t}\n+\n+\t\treturn matrix;\n+\t}\n+};\n+#endif /* __DOXYGEN__ */\n+\n+} /* namespace libcamera */\ndiff --git a/src/ipa/libipa/meson.build b/src/ipa/libipa/meson.build\nindex 496084233de7..1952dccf6236 100644\n--- a/src/ipa/libipa/meson.build\n+++ b/src/ipa/libipa/meson.build\n@@ -7,6 +7,7 @@ libipa_headers = files([\n 'exposure_mode_helper.h',\n 'fc_queue.h',\n 'histogram.h',\n+ 'matrix.h',\n 'module.h',\n 'pwl.h',\n 'vector.h',\n@@ -19,6 +20,7 @@ libipa_sources = files([\n 'exposure_mode_helper.cpp',\n 'fc_queue.cpp',\n 'histogram.cpp',\n+ 'matrix.cpp',\n 'module.cpp',\n 'pwl.cpp',\n 'vector.cpp',\n","prefixes":["v10","1/4"]}