Skip to main content

Overview

kapture-localization is a toolbox in which you will find implementations for various localization related algorithms. It strongly relies on the kapture format for data representation and manipulation.

The localization algorithms include:

  1. mapping,

  2. localization, and

  3. benchmarking (image retrieval for visual localization).

It works on Ubuntu, Windows, and MacOS.

Structure

The directories are organised as follow:

├── kapture_localization/  # package (library)
├── pipeline/              # main programs executing all steps of the localization pipelines
├── samples/               # some sample data
├── tests/                 # unit tests
└── tools/                 # sub programs involved in the pipeline

The kapture-localization toolbox is available as:

  • Python package (kapture_localization/),

  • Python executable scripts (pipeline/ & tools/).

There are 3 pipelines available:

  1. mapping,

  2. localization, and

  3. 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.6) and COLMAP (>=3.6), this toolbox can be installed with:

pip install kapture-localization

See doc/installation.adoc for more details.

Tutorial

See doc/tutorial for a short introduction and examples of the provided processing pipelines.

Contributing

There are many ways to contribute to the kapture-localization project:

  • provide feedback and suggestion,

  • submit bug reports in the project bug tracker,

  • implement a feature or bug-fix for an outstanding issue,

  • provide scripts to create data in kapture format (e.g. local/global feature extraction),

  • propose a new feature and implement it.

If you wish to contribute, please refer to the CONTRIBUTING page.

License

Software license is detailed in the LICENSE file.

References

If you use this work for your research, please cite the respective paper(s):

Structure-based localization or kapture format.

@misc{kapture2020,
      title={Robust Image Retrieval-based Visual Localization using Kapture},
      author={Martin Humenberger and Yohann Cabon and Nicolas Guerin and Julien Morat and Jérôme Revaud and Philippe Rerole and Noé Pion and Cesar de Souza and Vincent Leroy and Gabriela Csurka},
      year={2020},
      eprint={2007.13867},
      archivePrefix={arXiv},
      primaryClass={cs.CV}
}

Image retrieval benchmark.

@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}
}

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kapture-localization-0.1.3.tar.gz (58.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kapture_localization-0.1.3-py3-none-any.whl (97.6 kB view details)

Uploaded Python 3

File details

Details for the file kapture-localization-0.1.3.tar.gz.

File metadata

  • Download URL: kapture-localization-0.1.3.tar.gz
  • Upload date:
  • Size: 58.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.6.14

File hashes

Hashes for kapture-localization-0.1.3.tar.gz
Algorithm Hash digest
SHA256 fe9fcc594b063de513d118b08c4e18e702b62a038ed9937eb55c94302b4fdaee
MD5 64057af43c32c4f6b157cca502c9c127
BLAKE2b-256 77e56aaa1eec0df16dc4061d84f0239c6fec18113aed368f7eee4846a9615bc4

See more details on using hashes here.

File details

Details for the file kapture_localization-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: kapture_localization-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 97.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.6.14

File hashes

Hashes for kapture_localization-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 846de1822b272337495fa957af63ebbe39af31040614cb76ab517921c058090d
MD5 aba0980cb3e9c44663c76dcfb30e6a49
BLAKE2b-256 c639815f58eb438b7ceff705a32cfa588fb114dc88f75adcf2fde9b9ec4a82fa

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page