Skip to content

Commit

Permalink
Add more documentation based on first user feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
ahojnnes committed Apr 11, 2016
1 parent a88541c commit b782849
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 18 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ Getting Started
---------------

1. Download the pre-built binaries from
https://drive.google.com/folderview?id=0B_oNOlzQHU_Ha2hkdlRQYzQ4RDA#list
or build the library manually as described in the documentation.
http://people.inf.ethz.ch/jschoenb/colmap/ or build the library manually as
described in the documentation.
2. Watch the short introductory video at
https://www.youtube.com/watch?v=P-EC0DzeVEU or read the tutorial
in the documentation for more details.
Expand Down
8 changes: 4 additions & 4 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ General Public License. If you use this project for your research, please cite::
year={2016},
}

The latest source code is available at https://github.com/colmap/colmap.
The source code is available at https://github.com/colmap/colmap.


Getting Started
---------------

1. Download the pre-built binaries from `Google Drive
<https://drive.google.com/folderview?id=0B_oNOlzQHU_Ha2hkdlRQYzQ4RDA#list>`_
or build the library manually (see :ref:`Installation <installation>`).
1. Download the pre-built binaries from
http://people.inf.ethz.ch/jschoenb/colmap/ or build the library manually
(see :ref:`Installation <installation>`).
2. Watch the short introductory video at
`YouTube <https://www.youtube.com/watch?v=P-EC0DzeVEU>`_ or read the tutorial
for more details (see :ref:`Tutorial <tutorial>`).
Expand Down
20 changes: 10 additions & 10 deletions doc/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,19 @@
Installation
============

You can either download one of the pre-built binaries from the project website
or build the source code manually. It builds on all major platforms with minimal
effort: Linux, Mac, and Windows. First, checkout the latest source code::
You can either download one of the pre-built binaries from
http://people.inf.ethz.ch/jschoenb/colmap/ or build the source code manually. It
builds on all major platforms (Linux, Mac, Windows) with minimal effort. First,
checkout the latest source code::

git clone https://github.com/colmap/colmap


Linux
-----

*Recommended dependencies:* CUDA.

Dependencies from default Ubuntu 14.04 repositories::

sudo apt-get install \
Expand Down Expand Up @@ -47,14 +50,12 @@ Configure and compile COLMAP::
cmake ..
make -j

External dependencies: Ceres-Solver .

*Recommended dependencies:* CUDA.


Mac
---

*Recommended dependencies:* CUDA.

Dependencies from `Homebrew <http://brew.sh/>`_::

brew tap homebrew/science
Expand All @@ -72,7 +73,6 @@ Dependencies from `Homebrew <http://brew.sh/>`_::

Create `LocalConfig.cmake` in COLMAP base directory with::

message(STATUS "NOTE: Using LocalConfig.cmake to override CMake settings in the GUI")
set(Qt5_CMAKE_DIR "/usr/local/opt/qt5/lib/cmake")
set(Qt5Core_DIR ${Qt5_CMAKE_DIR}/Qt5Core)
set(Qt5OpenGL_DIR ${Qt5_CMAKE_DIR}/Qt5OpenGL)
Expand All @@ -84,8 +84,6 @@ Configure and compile COLMAP::
cmake ..
make -j

*Recommended dependencies:* CUDA.


Windows
-------
Expand All @@ -95,6 +93,8 @@ process of configuring CMake less painful, please have a look at
`LocalConfigExample.config`. MSVC12 (Microsoft Visual Studio 2013) and newer are
confirmed to compile COLMAP without any issues.

*Recommended dependencies:* CUDA.


Documentation
-------------
Expand Down
16 changes: 14 additions & 2 deletions doc/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -204,13 +204,13 @@ matching modes, that are intended for different input scenarios:
`image0002.jpg`, etc.). You can verify the correct order in the database
management tool (see :ref:`Database Format <database-format>`). Note that
loop detection requires a pre-trained vocabulary tree, that can be downloaded
from the project website.
from http://people.inf.ethz.ch/jschoenb/colmap/.

* **Vocabulary Tree Matching**: In this matching mode, every image is matched
against its visual nearest neighbors using a vocabulary tree. This is the
recommended matching mode for large image collections (several thousands).
This requires a pre-trained vocabulary tree, that can be downloaded from
the project website.
http://people.inf.ethz.ch/jschoenb/colmap/.

* **Spatial Matching**: This matching mode matches every image against its
spatial nearest neighbors. Spatial locations can be manually set in the
Expand Down Expand Up @@ -360,6 +360,18 @@ you can use COLMAP only for feature extraction and matching or you can import
your own features and matches to only use COLMAP's incremental reconstruction
algorithm.


Graphical and Command-line Interface
------------------------------------

Most of COLMAP's features are accessible from the graphical and the command-line
interface. All binaries accept a ``./bin -h`` (help) argument to list the
available options. You can provide the options directly as command-line
arguments or you can provide a `.ini` project configuration file containing the
options as the ``./bin --project_path`` argument. To start the GUI application,
please execute `src/exe/colmap`.


.. rubric:: Footnotes

.. [#f1] VisualSfM's projection model applies the distortion to the measurements
Expand Down

0 comments on commit b782849

Please sign in to comment.