README.md
1COLMAP
2======
3
4About
5-----
6
7COLMAP is a general-purpose Structure-from-Motion (SfM) and Multi-View Stereo
8(MVS) pipeline with a graphical and command-line interface. It offers a wide
9range of features for reconstruction of ordered and unordered image collections.
10The software is licensed under the new BSD license. If you use this project for
11your research, please cite:
12
13 @inproceedings{schoenberger2016sfm,
14 author={Sch\"{o}nberger, Johannes Lutz and Frahm, Jan-Michael},
15 title={Structure-from-Motion Revisited},
16 booktitle={Conference on Computer Vision and Pattern Recognition (CVPR)},
17 year={2016},
18 }
19
20 @inproceedings{schoenberger2016mvs,
21 author={Sch\"{o}nberger, Johannes Lutz and Zheng, Enliang and Pollefeys, Marc and Frahm, Jan-Michael},
22 title={Pixelwise View Selection for Unstructured Multi-View Stereo},
23 booktitle={European Conference on Computer Vision (ECCV)},
24 year={2016},
25 }
26
27If you use the image retrieval / vocabulary tree engine, please also cite:
28
29 @inproceedings{schoenberger2016vote,
30 author={Sch\"{o}nberger, Johannes Lutz and Price, True and Sattler, Torsten and Frahm, Jan-Michael and Pollefeys, Marc},
31 title={A Vote-and-Verify Strategy for Fast Spatial Verification in Image Retrieval},
32 booktitle={Asian Conference on Computer Vision (ACCV)},
33 year={2016},
34 }
35
36The latest source code is available at https://github.com/colmap/colmap. COLMAP
37builds on top of existing works and when using specific algorithms within
38COLMAP, please also cite the original authors, as specified in the source code.
39
40
41Download
42--------
43
44Executables for Windows and Mac and other resources can be downloaded from
45https://demuc.de/colmap/. Executables for Linux/Unix/BSD are available at
46https://repology.org/metapackage/colmap/versions. To build COLMAP from source,
47please see https://colmap.github.io/install.html.
48
49Getting Started
50---------------
51
521. Download the pre-built binaries from https://demuc.de/colmap/ or build the
53 library manually as described in the documentation.
542. Download one of the provided datasets at https://demuc.de/colmap/datasets/
55 or use your own images.
563. Use the **automatic reconstruction** to easily build models
57 with a single click or command.
584. Watch the short introductory video at
59 https://www.youtube.com/watch?v=P-EC0DzeVEU or read the tutorial
60 in the documentation at https://colmap.github.io/ for more details.
61
62
63Documentation
64-------------
65
66The documentation is available at https://colmap.github.io/.
67
68
69Support
70-------
71
72Please, use the COLMAP Google Group at
73https://groups.google.com/forum/#!forum/colmap (colmap@googlegroups.com) for
74questions and the GitHub issue tracker at https://github.com/colmap/colmap for
75bug reports, feature requests/additions, etc.
76
77
78Acknowledgments
79---------------
80
81The library was written by Johannes L. Schönberger (https://demuc.de/). Funding
82was provided by his PhD advisors Jan-Michael Frahm (http://frahm.web.unc.edu/)
83and Marc Pollefeys (https://www.inf.ethz.ch/personal/marc.pollefeys/).
84
85
86Contribution
87------------
88
89Contributions (bug reports, bug fixes, improvements, etc.) are very welcome and
90should be submitted in the form of new issues and/or pull requests on GitHub.
91
92
93License
94-------
95
96The COLMAP library is licensed under the new BSD license. Note that this text
97refers only to the license for COLMAP itself, independent of its dependencies,
98which are separately licensed. Building COLMAP with these dependencies may
99affect the resulting COLMAP license.
100
101 Copyright (c) 2018, ETH Zurich and UNC Chapel Hill.
102 All rights reserved.
103
104 Redistribution and use in source and binary forms, with or without
105 modification, are permitted provided that the following conditions are met:
106
107 * Redistributions of source code must retain the above copyright
108 notice, this list of conditions and the following disclaimer.
109
110 * Redistributions in binary form must reproduce the above copyright
111 notice, this list of conditions and the following disclaimer in the
112 documentation and/or other materials provided with the distribution.
113
114 * Neither the name of ETH Zurich and UNC Chapel Hill nor the names of
115 its contributors may be used to endorse or promote products derived
116 from this software without specific prior written permission.
117
118 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
119 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
120 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
121 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
122 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
123 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
124 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
125 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
126 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
127 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
128 POSSIBILITY OF SUCH DAMAGE.
129
130 Author: Johannes L. Schoenberger (jsch-at-demuc-dot-de)
131