PyCOLMAP API documentation (#8)

Result of colmap/colmap#2749

Author: sarlinpe

.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: 931eef9d69ef24c6e22dbc546f30bf31
+config: 7ecbe026126241ce4cdf145a49680b0e
 tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/index.rst.txt

@@ -101,6 +101,7 @@ third-party tooling, and community support.
    datasets
    gui
    cli
+   pycolmap/index
    faq
    changelog
    contribution

_sources/pycolmap/api.rst.txt

@@ -0,0 +1,9 @@
+.. _pycolmap/api:
+
+API
+============
+
+.. automodule:: pycolmap
+   :members:
+   :undoc-members:
+

_sources/pycolmap/cost_functions.rst.txt

@@ -0,0 +1,8 @@
+.. _pycolmap/cost_functions:
+
+Cost Functions
+==============
+
+.. automodule:: pycolmap.cost_functions
+   :members:
+   :undoc-members:

_sources/pycolmap/index.rst.txt

@@ -0,0 +1,39 @@
+.. _pycolmap/index:
+
+PyCOLMAP
+========
+
+PyCOLMAP exposes to Python most capabilities of COLMAP.
+
+Installation
+------------
+
+Pre-built wheels for Linux, macOS, and Windows can be installed using pip::
+
+   pip install pycolmap
+
+The wheels are automatically built and pushed to `PyPI <https://pypi.org/project/pycolmap/>`_ at each release. They are currently not built with CUDA support, which requires building from source. To build PyCOLMAP from source, follow these steps:
+
+1. Install COLMAP from source following :ref:`installation`.
+2. Build PyCOLMAP:
+
+   * On Linux and macOS::
+
+      python -m pip install ./pycolmap/
+
+   * On Windows, after installing COLMAP via VCPKG, run in powershell::
+
+      python -m pip install ./pycolmap/ `
+          --cmake.define.CMAKE_TOOLCHAIN_FILE="$VCPKG_INSTALLATION_ROOT/scripts/buildsystems/vcpkg.cmake" `
+          --cmake.define.VCPKG_TARGET_TRIPLET="x64-windows"
+
+Some features, such as cost functions, require that `PyCeres <https://github.com/cvg/pyceres>`_ is installed in the same as PyCOLMAP, so either from PyPI or from source.
+
+Usage
+-----
+
+.. toctree::
+   :maxdepth: 2
+
+   api
+   cost_functions

_static/custom.css

@@ -0,0 +1,4 @@
+/*Fixes https://github.com/readthedocs/sphinx_rtd_theme/issues/1301#issuecomment-1876120817 */
+.py.property {
+    display: block !important;
+}

bibliography.html

@@ -7,6 +7,7 @@
   <title>Bibliography &mdash; COLMAP 3.11.0.dev0 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
+      <link rel="stylesheet" type="text/css" href="_static/custom.css?v=22544140" />
 
 
   <!--[if lt IE 9]>
@@ -55,6 +56,7 @@
 <li class="toctree-l1"><a class="reference internal" href="datasets.html">Datasets</a></li>
 <li class="toctree-l1"><a class="reference internal" href="gui.html">Graphical User Interface</a></li>
 <li class="toctree-l1"><a class="reference internal" href="cli.html">Command-line Interface</a></li>
+<li class="toctree-l1"><a class="reference internal" href="pycolmap/index.html">PyCOLMAP</a></li>
 <li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contribution.html">Contribution</a></li>

cameras.html

@@ -7,6 +7,7 @@
   <title>Camera Models &mdash; COLMAP 3.11.0.dev0 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
+      <link rel="stylesheet" type="text/css" href="_static/custom.css?v=22544140" />
 
 
   <!--[if lt IE 9]>
@@ -56,6 +57,7 @@
 <li class="toctree-l1"><a class="reference internal" href="datasets.html">Datasets</a></li>
 <li class="toctree-l1"><a class="reference internal" href="gui.html">Graphical User Interface</a></li>
 <li class="toctree-l1"><a class="reference internal" href="cli.html">Command-line Interface</a></li>
+<li class="toctree-l1"><a class="reference internal" href="pycolmap/index.html">PyCOLMAP</a></li>
 <li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contribution.html">Contribution</a></li>

changelog.html

@@ -7,6 +7,7 @@
   <title>Changelog &mdash; COLMAP 3.11.0.dev0 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
+      <link rel="stylesheet" type="text/css" href="_static/custom.css?v=22544140" />
 
 
   <!--[if lt IE 9]>
@@ -56,6 +57,7 @@
 <li class="toctree-l1"><a class="reference internal" href="datasets.html">Datasets</a></li>
 <li class="toctree-l1"><a class="reference internal" href="gui.html">Graphical User Interface</a></li>
 <li class="toctree-l1"><a class="reference internal" href="cli.html">Command-line Interface</a></li>
+<li class="toctree-l1"><a class="reference internal" href="pycolmap/index.html">PyCOLMAP</a></li>
 <li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#colmap-3-10-07-23-2024">COLMAP 3.10 (07/23/2024)</a></li>

cli.html

@@ -7,6 +7,7 @@
   <title>Command-line Interface &mdash; COLMAP 3.11.0.dev0 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
+      <link rel="stylesheet" type="text/css" href="_static/custom.css?v=22544140" />
 
 
   <!--[if lt IE 9]>
@@ -21,7 +22,7 @@
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="Frequently Asked Questions" href="faq.html" />
+    <link rel="next" title="PyCOLMAP" href="pycolmap/index.html" />
     <link rel="prev" title="Graphical User Interface" href="gui.html" /> 
 </head>
 
@@ -62,6 +63,7 @@
 <li class="toctree-l2"><a class="reference internal" href="#visualization">Visualization</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="pycolmap/index.html">PyCOLMAP</a></li>
 <li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contribution.html">Contribution</a></li>
@@ -375,7 +377,7 @@ <h2>Visualization<a class="headerlink" href="#visualization" title="Link to this
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="gui.html" class="btn btn-neutral float-left" title="Graphical User Interface" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="faq.html" class="btn btn-neutral float-right" title="Frequently Asked Questions" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="pycolmap/index.html" class="btn btn-neutral float-right" title="PyCOLMAP" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>