Skip to content

Commit

Permalink
docs: update sphinx docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@ACornuIGN
ACornuIGN committed Oct 4, 2024
1 parent fd5da8f commit 6f20fb2
Show file tree
Hide file tree
Showing 131 changed files with 1,231 additions and 388 deletions.
Empty file added borea/utils/solver/__init__.py
View file
Empty file.
Binary file modified docs/sphinx/_build/doctrees/borea.datastruct.doctree
View file
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/borea.doctree
View file
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/borea.format.doctree
View file
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/borea.geodesy.doctree
View file
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/borea.geodesy.projectionlist.doctree
View file
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/borea.process.doctree
View file
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/borea.process.p_add_data.doctree
View file
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/borea.process.p_format.doctree
View file
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/borea.process.p_func.doctree
View file
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/borea.reader.doctree
View file
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/borea.reader.orientation.doctree
View file
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/borea.stat.doctree
View file
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/borea.transform_world_image.doctree
View file
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/borea.transform_world_image.transform_dtm.doctree
View file
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/borea.transform_world_image.transform_shot.doctree
View file
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/borea.transform_world_image.transform_worksite.doctree
View file
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/borea.utils.check.doctree
View file
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/borea.utils.doctree
View file
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/borea.utils.miscellaneous.doctree
View file
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/borea.utils.singleton.doctree
View file
Binary file not shown.
Binary file added docs/sphinx/_build/doctrees/borea.utils.solver.doctree
View file
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/borea.utils.xml.doctree
View file
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/borea.worksite.doctree
View file
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/borea.writer.doctree
View file
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/index.doctree
View file
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/modules.doctree
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/sphinx/_build/html/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -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
8 changes: 4 additions & 4 deletions docs/sphinx/_build/html/_modules/borea/datastruct/camera.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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" />
Expand Down Expand Up @@ -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">
Expand All @@ -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">
Expand Down Expand Up @@ -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>
Expand Down
8 changes: 4 additions & 4 deletions docs/sphinx/_build/html/_modules/borea/datastruct/dtm.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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" />
Expand Down Expand Up @@ -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">
Expand All @@ -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">
Expand Down Expand Up @@ -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>
Expand Down
8 changes: 4 additions & 4 deletions docs/sphinx/_build/html/_modules/borea/datastruct/gcp.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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" />
Expand Down Expand Up @@ -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">
Expand All @@ -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">
Expand Down Expand Up @@ -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>
Expand Down
8 changes: 4 additions & 4 deletions docs/sphinx/_build/html/_modules/borea/datastruct/shot.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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" />
Expand Down Expand Up @@ -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">
Expand All @@ -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">
Expand Down Expand Up @@ -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>
Expand Down
8 changes: 4 additions & 4 deletions docs/sphinx/_build/html/_modules/borea/datastruct/workdata.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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" />
Expand Down Expand Up @@ -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">
Expand All @@ -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">
Expand Down Expand Up @@ -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>
Expand Down
8 changes: 4 additions & 4 deletions docs/sphinx/_build/html/_modules/borea/format/conl.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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" />
Expand Down Expand Up @@ -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">
Expand All @@ -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">
Expand Down Expand Up @@ -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>
Expand Down
11 changes: 6 additions & 5 deletions docs/sphinx/_build/html/_modules/borea/format/rpc.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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" />
Expand Down Expand Up @@ -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">
Expand All @@ -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">
Expand Down Expand Up @@ -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">
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
8 changes: 4 additions & 4 deletions docs/sphinx/_build/html/_modules/borea/geodesy/approx_euclidean_proj.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.geodesy.approx_euclidean_proj - Borea 1.0.0 documentation</title>
<title>borea.geodesy.approx_euclidean_proj - 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" />
Expand Down Expand Up @@ -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">
Expand All @@ -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">
Expand Down Expand Up @@ -410,7 +410,7 @@ <h1>Source code for borea.geodesy.approx_euclidean_proj</h1><div class="highligh

</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>
Expand Down
Loading

0 comments on commit 6f20fb2

Please sign in to comment.