= kapture-localization: toolbox :sectnums: :sectnumlevels: 1 :toc: macro :toclevels: 2
toc::[]
== Overview
kapture-localization is a toolbox in which you will find implementations for various localization related algorithms. It strongly relies on the https://github.com/naver/kapture[kapture] format for data representation and manipulation.
The localization algorithms include:
. mapping, . localization, and . benchmarking (image retrieval for visual localization).
It works on Ubuntu, Windows, and MacOS.
== Structure
The directories are organised as follow:
The kapture-localization toolbox is available as:
kapture_localization/
),pipeline/
& tools/
).There are 3 pipelines available:
. mapping, . localization, and . image retrieval benchmark (global sfm, local sfm, pose approximation).
== Installation
It can be installed using docker, pip or from manually from source code. After installing python (>=3.8) and COLMAP (>=3.6), this toolbox can be installed with:
See link:doc/installation.adoc[] for more details.
== Tutorial
See link:doc/tutorial.adoc[doc/tutorial] for a short introduction and examples of the provided processing pipelines.
== Image Retrieval Benchmark
link:doc/benchmark.adoc[Benchmark pipeline]
link:doc/benchmark_results.adoc[Benchmark results]
== Contributing
There are many ways to contribute to the kapture-localization project:
// TODO individual page for kapture-localization ? If you wish to contribute, please refer to the link:https://github.com/naver/kapture/blob/main/CONTRIBUTING.adoc[CONTRIBUTING] page.
== License Software license is detailed in the link:LICENSE[LICENSE] file.
== References If you use this work for your research, please cite the respective paper(s):
@inproceedings{benchmarking_ir3DV2020, title={Benchmarking Image Retrieval for Visual Localization}, author={Noé Pion, Martin Humenberger, Gabriela Csurka, Yohann Cabon, Torsten Sattler}, year={2020}, booktitle={International Conference on 3D Vision} }