Merge pull request #159 from IGNF/dev

Add new feature

.github/workflows/publish_pypi.yml

@@ -0,0 +1,53 @@
+name: Publish ign-borea package on PyPI
+
+on:
+  release:
+    types: [released]
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+
+    - name: Install pypa/build
+      run: python3 -m pip install build
+
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+
+  publish-to-pypi:
+      name: Publish Python distribution to PyPI
+      needs:
+        - build
+      runs-on: ubuntu-latest
+
+      environment:
+        name: pypi
+        url: https://pypi.org/p/ign-borea
+
+      permissions:
+        id-token: write
+
+      steps:
+        - name: Download all the dists
+          uses: actions/download-artifact@v4
+          with:
+            name: python-package-distributions
+            path: dist/
+
+        - name: Publish distribution to TestPyPI
+          uses: pypa/gh-action-pypi-publish@release/v1

borea/format/rpc.py

@@ -9,6 +9,7 @@
 from borea.transform_world_image.transform_shot.image_world_shot import ImageWorldShot
 from borea.transform_world_image.transform_shot.world_image_shot import WorldImageShot
 from borea.utils.miscellaneous.miscellaneous import normalize
+from borea.utils.solver.solver import npsolve
 
 
 class Rpc:
@@ -161,7 +162,7 @@ def least_square_rpc(self, img_norm: np.ndarray, world_norm: np.ndarray,
             np.array: Rpc coefficients.
         """
         mat_obs = self.setup_matrix_obs_rpc(img_norm, world_norm, polynomial_degree)
-        x = np.linalg.lstsq(mat_obs, img_norm, rcond=None)[0]
+        x = npsolve(mat_obs, img_norm)
 
         coef_rpc = np.zeros(40)
         if polynomial_degree == 1:

borea/transform_world_image/transform_worksite/space_resection.py

@@ -13,6 +13,7 @@
 # pylint: disable-next=line-too-long
 from borea.transform_world_image.transform_worksite.image_world_intersection import WorldIntersection  # noqa: E501
 from borea.utils.miscellaneous.param_bundle import set_param_bundle_diff
+from borea.utils.solver.solver import npsolve
 
 
 class SpaceResection:
@@ -240,8 +241,7 @@ def func_least_square(self, shot_adjust: Shot, obs: np.ndarray,
 
         # Creation of A with mat_obs_axia
         # Calculate dx = (A.T @ A)**-1 @ A.T @ B
-        return np.squeeze(np.linalg.lstsq(self.mat_obs_axia(pt_eucli, shot_adjust),
-                                          v_res, rcond=None)[0])
+        return np.squeeze(npsolve(self.mat_obs_axia(pt_eucli, shot_adjust), v_res))
 
     def mat_obs_axia(self, pt_eucli: np.ndarray, imc_adjust: Shot) -> np.ndarray:
         """

borea/utils/solver/solver.py

@@ -0,0 +1,18 @@
+"""
+Least square solver used by Borea
+"""
+import numpy as np
+
+
+def npsolve(mat_a: np.ndarray, mat_b: np.ndarray) -> np.ndarray:
+    """
+    Solver used by Borea to resolve Ax = B
+
+    Args:
+        mat_a (np.ndarray): Matrix A
+        mat_b (np.ndarray): Matrix B
+
+    Returns:
+        np.ndarray: the result x
+    """
+    return np.linalg.lstsq(mat_a, mat_b, rcond=None)[0]

docs/sphinx/_build/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 504fc0b18f5078da3c2b6c957c5c94f7
+config: 1377150614254adb87c28fd596e900be
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/sphinx/_build/html/_modules/borea/datastruct/camera.html

@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../../genindex.html" /><link rel="search" title="Search" href="../../../search.html" />
 
     <!-- Generated with Sphinx 8.0.2 and Furo 2024.08.06 -->
-        <title>borea.datastruct.camera - Borea 1.0.0 documentation</title>
+        <title>borea.datastruct.camera - Borea 0.2.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=354aac6f" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=302659d7" />
@@ -165,7 +165,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../index.html"><div class="brand">Borea 1.0.0 documentation</div></a>
+      <a href="../../../index.html"><div class="brand">Borea 0.2.1 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -189,7 +189,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../../index.html">
 
 
-  <span class="sidebar-brand-text">Borea 1.0.0 documentation</span>
+  <span class="sidebar-brand-text">Borea 0.2.1 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -332,7 +332,7 @@ <h1>Source code for borea.datastruct.camera</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script src="../../../_static/documentation_options.js?v=8d563738"></script>
+</div><script src="../../../_static/documentation_options.js?v=37f418d5"></script>
     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/scripts/furo.js?v=5fa4622c"></script>

docs/sphinx/_build/html/_modules/borea/datastruct/dtm.html

@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../../genindex.html" /><link rel="search" title="Search" href="../../../search.html" />
 
     <!-- Generated with Sphinx 8.0.2 and Furo 2024.08.06 -->
-        <title>borea.datastruct.dtm - Borea 1.0.0 documentation</title>
+        <title>borea.datastruct.dtm - Borea 0.2.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=354aac6f" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=302659d7" />
@@ -165,7 +165,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../index.html"><div class="brand">Borea 1.0.0 documentation</div></a>
+      <a href="../../../index.html"><div class="brand">Borea 0.2.1 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -189,7 +189,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../../index.html">
 
 
-  <span class="sidebar-brand-text">Borea 1.0.0 documentation</span>
+  <span class="sidebar-brand-text">Borea 0.2.1 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -441,7 +441,7 @@ <h1>Source code for borea.datastruct.dtm</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script src="../../../_static/documentation_options.js?v=8d563738"></script>
+</div><script src="../../../_static/documentation_options.js?v=37f418d5"></script>
     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/scripts/furo.js?v=5fa4622c"></script>

docs/sphinx/_build/html/_modules/borea/datastruct/gcp.html

@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../../genindex.html" /><link rel="search" title="Search" href="../../../search.html" />
 
     <!-- Generated with Sphinx 8.0.2 and Furo 2024.08.06 -->
-        <title>borea.datastruct.gcp - Borea 1.0.0 documentation</title>
+        <title>borea.datastruct.gcp - Borea 0.2.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=354aac6f" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=302659d7" />
@@ -165,7 +165,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../index.html"><div class="brand">Borea 1.0.0 documentation</div></a>
+      <a href="../../../index.html"><div class="brand">Borea 0.2.1 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -189,7 +189,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../../index.html">
 
 
-  <span class="sidebar-brand-text">Borea 1.0.0 documentation</span>
+  <span class="sidebar-brand-text">Borea 0.2.1 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -329,7 +329,7 @@ <h1>Source code for borea.datastruct.gcp</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script src="../../../_static/documentation_options.js?v=8d563738"></script>
+</div><script src="../../../_static/documentation_options.js?v=37f418d5"></script>
     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/scripts/furo.js?v=5fa4622c"></script>

docs/sphinx/_build/html/_modules/borea/datastruct/shot.html

@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../../genindex.html" /><link rel="search" title="Search" href="../../../search.html" />
 
     <!-- Generated with Sphinx 8.0.2 and Furo 2024.08.06 -->
-        <title>borea.datastruct.shot - Borea 1.0.0 documentation</title>
+        <title>borea.datastruct.shot - Borea 0.2.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=354aac6f" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=302659d7" />
@@ -165,7 +165,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../index.html"><div class="brand">Borea 1.0.0 documentation</div></a>
+      <a href="../../../index.html"><div class="brand">Borea 0.2.1 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -189,7 +189,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../../index.html">
 
 
-  <span class="sidebar-brand-text">Borea 1.0.0 documentation</span>
+  <span class="sidebar-brand-text">Borea 0.2.1 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -568,7 +568,7 @@ <h1>Source code for borea.datastruct.shot</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script src="../../../_static/documentation_options.js?v=8d563738"></script>
+</div><script src="../../../_static/documentation_options.js?v=37f418d5"></script>
     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/scripts/furo.js?v=5fa4622c"></script>

docs/sphinx/_build/html/_modules/borea/datastruct/workdata.html

@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../../genindex.html" /><link rel="search" title="Search" href="../../../search.html" />
 
     <!-- Generated with Sphinx 8.0.2 and Furo 2024.08.06 -->
-        <title>borea.datastruct.workdata - Borea 1.0.0 documentation</title>
+        <title>borea.datastruct.workdata - Borea 0.2.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=354aac6f" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=302659d7" />
@@ -165,7 +165,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../index.html"><div class="brand">Borea 1.0.0 documentation</div></a>
+      <a href="../../../index.html"><div class="brand">Borea 0.2.1 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -189,7 +189,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../../index.html">
 
 
-  <span class="sidebar-brand-text">Borea 1.0.0 documentation</span>
+  <span class="sidebar-brand-text">Borea 0.2.1 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -564,7 +564,7 @@ <h1>Source code for borea.datastruct.workdata</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script src="../../../_static/documentation_options.js?v=8d563738"></script>
+</div><script src="../../../_static/documentation_options.js?v=37f418d5"></script>
     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/scripts/furo.js?v=5fa4622c"></script>

docs/sphinx/_build/html/_modules/borea/format/conl.html

@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../../genindex.html" /><link rel="search" title="Search" href="../../../search.html" />
 
     <!-- Generated with Sphinx 8.0.2 and Furo 2024.08.06 -->
-        <title>borea.format.conl - Borea 1.0.0 documentation</title>
+        <title>borea.format.conl - Borea 0.2.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=354aac6f" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=302659d7" />
@@ -165,7 +165,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../index.html"><div class="brand">Borea 1.0.0 documentation</div></a>
+      <a href="../../../index.html"><div class="brand">Borea 0.2.1 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -189,7 +189,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../../index.html">
 
 
-  <span class="sidebar-brand-text">Borea 1.0.0 documentation</span>
+  <span class="sidebar-brand-text">Borea 0.2.1 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -455,7 +455,7 @@ <h1>Source code for borea.format.conl</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script src="../../../_static/documentation_options.js?v=8d563738"></script>
+</div><script src="../../../_static/documentation_options.js?v=37f418d5"></script>
     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/scripts/furo.js?v=5fa4622c"></script>

docs/sphinx/_build/html/_modules/borea/format/rpc.html

@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../../genindex.html" /><link rel="search" title="Search" href="../../../search.html" />
 
     <!-- Generated with Sphinx 8.0.2 and Furo 2024.08.06 -->
-        <title>borea.format.rpc - Borea 1.0.0 documentation</title>
+        <title>borea.format.rpc - Borea 0.2.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=354aac6f" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=302659d7" />
@@ -165,7 +165,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../index.html"><div class="brand">Borea 1.0.0 documentation</div></a>
+      <a href="../../../index.html"><div class="brand">Borea 0.2.1 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -189,7 +189,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../../index.html">
 
 
-  <span class="sidebar-brand-text">Borea 1.0.0 documentation</span>
+  <span class="sidebar-brand-text">Borea 0.2.1 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -283,6 +283,7 @@ <h1>Source code for borea.format.rpc</h1><div class="highlight"><pre>
 <span class="kn">from</span> <span class="nn">borea.transform_world_image.transform_shot.image_world_shot</span> <span class="kn">import</span> <span class="n">ImageWorldShot</span>
 <span class="kn">from</span> <span class="nn">borea.transform_world_image.transform_shot.world_image_shot</span> <span class="kn">import</span> <span class="n">WorldImageShot</span>
 <span class="kn">from</span> <span class="nn">borea.utils.miscellaneous.miscellaneous</span> <span class="kn">import</span> <span class="n">normalize</span>
+<span class="kn">from</span> <span class="nn">borea.utils.solver.solver</span> <span class="kn">import</span> <span class="n">npsolve</span>
 
 
 <div class="viewcode-block" id="Rpc">
@@ -448,7 +449,7 @@ <h1>Source code for borea.format.rpc</h1><div class="highlight"><pre>
 <span class="sd">            np.array: Rpc coefficients.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">mat_obs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">setup_matrix_obs_rpc</span><span class="p">(</span><span class="n">img_norm</span><span class="p">,</span> <span class="n">world_norm</span><span class="p">,</span> <span class="n">polynomial_degree</span><span class="p">)</span>
-        <span class="n">x</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">linalg</span><span class="o">.</span><span class="n">lstsq</span><span class="p">(</span><span class="n">mat_obs</span><span class="p">,</span> <span class="n">img_norm</span><span class="p">,</span> <span class="n">rcond</span><span class="o">=</span><span class="kc">None</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
+        <span class="n">x</span> <span class="o">=</span> <span class="n">npsolve</span><span class="p">(</span><span class="n">mat_obs</span><span class="p">,</span> <span class="n">img_norm</span><span class="p">)</span>
 
         <span class="n">coef_rpc</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="mi">40</span><span class="p">)</span>
         <span class="k">if</span> <span class="n">polynomial_degree</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
@@ -573,7 +574,7 @@ <h1>Source code for borea.format.rpc</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script src="../../../_static/documentation_options.js?v=8d563738"></script>
+</div><script src="../../../_static/documentation_options.js?v=37f418d5"></script>
     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/scripts/furo.js?v=5fa4622c"></script>