Skip to main content

kapture-localization: localization pipelines based on kapture.

Project description

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

Project details


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.4.tar.gz (62.4 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.4-py3-none-any.whl (107.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kapture-localization-0.1.4.tar.gz
  • Upload date:
  • Size: 62.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.6.14

File hashes

Hashes for kapture-localization-0.1.4.tar.gz
Algorithm Hash digest
SHA256 dccceb36772b01fa3ab0b53b0baadbc76c129555365cb91a7f24f2cdbe56dce8
MD5 8e0d469274aa1ca019f9c2cb669b98c9
BLAKE2b-256 3cbcacb42287c874f2da83e4ccf28b19f17ab7fa9fbf1b0115dd5cdc6cb37070

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kapture_localization-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 107.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.6.14

File hashes

Hashes for kapture_localization-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 86d84f884e1e3649d82e54435f402b9817df8eeac24e67482eae59155e27e51b
MD5 8c1a24f92b69ad8dee58b0caf1ce019e
BLAKE2b-256 46a830a56e8bcc26a92019ebdccb5a51d60fb4f82176be65b1b46fe460ba7b3b

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 Pingdom Monitoring Sentry Error logging StatusPage Status page