Hierarchical-Localization

Python LINK

Visual localization made easy

hloc - the hierarchical localization toolbox

This is hloc, a modular toolbox for state-of-the-art 6-DoF visual localization. It implements Hierarchical Localization, leveraging image retrieval and feature matching, and is fast, accurate, and scalable. This codebase won the indoor/outdoor localization challenge at CVPR 2020, in combination with SuperGlue, our graph neural network for feature matching.

With hloc, you can:

Reproduce our CVPR 2020 winning results on outdoor (Aachen) and indoor (InLoc) datasets
Run Structure-from-Motion with SuperPoint+SuperGlue to localize with your own datasets
Evaluate your own local features or image retrieval for visual localization
Implement new localization pipelines and debug them easily ?

Hierachical Localization uses both image retrieval and feature matching

Installation

hloc requires Python >=3.6, PyTorch >=1.1, and COLMAP. Other minor dependencies are listed in requirements.txt. For pose estimation, we use pycolmap, which can be installed as:

pip install git+https://github.com/mihaidusmanu/pycolmap

This codebase includes external local features as git submodules – don't forget to pull submodules with git submodule update --init --recursive. Your local features are based on TensorFlow? No problem! See below for the steps.

We also provide a Docker image that includes COLMAP and other dependencies:

docker build -t hloc:latest .
docker run -it -p 8888:8888 hloc:latest
jupyter notebook --ip 0.0.0.0 --port 8888 --no-browser --allow-root

General pipeline

The toolbox is composed of scripts, which roughly perform the following steps:

Extract SuperPoint local features for all database and query images
Build a reference 3D SfM model
1. Find covisible database images, with retrieval or a prior SfM model
2. Match these database pairs with SuperGlue
3. Triangulate a new SfM model with COLMAP
Find database images relevant to each query, using retrieval
Match the query images with SuperGlue
Run the localization
Visualize and debug

The localization can then be evaluated on visuallocalization.net for the supported datasets. When 3D Lidar scans are available, such as for the indoor dataset InLoc, step 2. can be skipped.

Strcture of the toolbox:

hloc/*.py : top-level scripts
hloc/extractors/ : interfaces for feature extractors
hloc/matchers/ : interfaces for feature matchers

Tasks

We provide step-by-step guides to localize with Aachen, InLoc, and to generate reference poses for your own data using SfM. Just download the datasets and you're reading to go!

Aachen – outdoor localization

Have a look at pipeline_Aachen.ipynb for a step-by-step guide on localizing with Aachen. Play with the visualization, try new local features or matcher, and have fun! Don't like notebooks? You can also run all scripts from the command line.

InLoc – indoor localization

The notebook pipeline_InLoc.ipynb shows the steps for localizing with InLoc. It's much simpler since a 3D SfM model is not needed.

SfM reconstruction from scratch

We show in pipeline_SfM.ipynb how to run 3D reconstruction for an unordered set of images. This generates reference poses, and a nice sparse 3D model suitable for localization with the same pipeline as Aachen.

Results

hloc currently supports SuperPoint and D2-Net local feature extractors; and SuperGlue and Nearest Neighbor matchers. Using NetVLAD for retrieval, we obtain the following best results:

Methods	Aachen day	Aachen night	Retrieval
SuperPoint + SuperGlue	89.6 / 95.4 / 98.8	86.7 / 93.9 / 100	NetVLAD top 50
SuperPoint + NN	85.4 / 93.3 / 97.2	75.5 / 86.7 / 92.9	NetVLAD top 30
D2Net (SS) + NN	84.6 / 91.4 / 97.1	83.7 / 90.8 / 100	NetVLAD top 30

Methods	InLoc DUC1	InLoc DUC2	Retrieval
SuperPoint + SuperGlue	46.5 / 65.7 / 78.3	52.7 / 72.5 / 79.4	NetVLAD top 40
SuperPoint + SuperGlue (temporal)	49.0 / 68.7 / 80.8	53.4 / 77.1 / 82.4	NetVLAD top 40
SuperPoint + NN	39.9 / 55.6 / 67.2	37.4 / 57.3 / 70.2	NetVLAD top 20
D2Net (SS) + NN	39.9 / 57.6 / 67.2	36.6 / 53.4 / 61.8	NetVLAD top 20

Check out visuallocalization.net/benchmark for more details and additional baselines.

BibTex Citation

If you report any of the above results in a publication, or use any of the tools provided here, please consider citing both Hierarchical Localization and SuperGlue papers:

@inproceedings{sarlin2019coarse,
  title     = {From Coarse to Fine: Robust Hierarchical Localization at Large Scale},
  author    = {Paul-Edouard Sarlin and
               Cesar Cadena and
               Roland Siegwart and
               Marcin Dymczyk},
  booktitle = {CVPR},
  year      = {2019}
}

@inproceedings{sarlin2020superglue,
  title     = {{SuperGlue}: Learning Feature Matching with Graph Neural Networks},
  author    = {Paul-Edouard Sarlin and
               Daniel DeTone and
               Tomasz Malisiewicz and
               Andrew Rabinovich},
  booktitle = {CVPR},
  year      = {2020},
}

Going further

Debugging and Visualization

[Click to expand] Each localization run generates a pickle log file. For each query, it contains the selected database images, their matches, and information from the pose solver, such as RANSAC inliers. It can thus be parsed to gather statistics and analyze failure modes or difficult scenarios. We also provide some visualization tools in [`hloc/visualization.py`](./hloc/visualization.py) to visualize some attributes of the 3D SfM model, such as visibility of the keypoints, their track length, or estimated sparse depth (like below).

Using your own local features or matcher

[Click to expand] If your code is based on PyTorch: simply add a new interface in [`hloc/extractors/`](hloc/extractors/) or [`hloc/matchers/`](hloc/matchers/). It needs to inherit from `hloc.utils.base_model.BaseModel`, take as input a data dictionary, and output a prediction dictionary. Have a look at `hloc/extractors/superpoint.py` for an example. You can additionally define a standard configuration in [`hloc/extract_features.py`](hloc/extract_features.py) or [`hloc/match_features.py`](hloc/match_features.py) - it can then be called directly from the command line. If your code is based on TensorFlow: you will need to either modify `hloc/extract_features.py` and `hloc/match_features.py`, or export yourself the features and matches to HDF5 files, described below. In a feature file, each key corresponds to the relative path of an image w.r.t. the dataset root (e.g. `db/1.jpg` for Aachen), and has one dataset per prediction (e.g. `keypoints` and `descriptors`, with shape Nx2 and DxN). In a match file, each key corresponds to the string `path0.replace('/', '-')+'_'+path1.replace('/', '-')` and has a dataset `matches0` with shape N. It indicates, for each keypoint in the first image, the index of the matching keypoint in the second image, or `-1` if the keypoint is unmatched.

Using your own image retrieval

[Click to expand] For now `hloc` does not have an interface for image retrieval. You will need to export the global descriptors into an HDF5 file, in which each key corresponds to the relative path of an image w.r.t. the dataset root, and contains a dataset `global_descriptor` with size D. You can then export the images pairs with [`hloc/pairs_from_retrieval.py`](hloc/pairs_from_retrieval.py).

Contributions welcome!

External contributions are very much welcome. This is a non-exaustive list of features that might be valuable additions:

[ ] more localization datasets (RobotCar Seasons, CMU Seasons, Aachen v1.1, Cambridge Landmarks, 7Scenes)
[ ] covisibility clustering for InLoc
[ ] visualization of the raw predictions (features and matches)
[ ] interfaces for image retrieval (e.g. DIR, NetVLAD)
[ ] other local features

Created and maintained by Paul-Edouard Sarlin.

Recent Trend