OpenVSLAM: A Versatile Visual SLAM Framework

Overview

OpenVSLAM is a monocular, stereo, and RGBD visual SLAM system. The notable features are:

It is compatible with various type of camera models and can be easily customized for other camera models.
Created maps can be stored and loaded, then OpenVSLAM can localize new images based on the prebuilt maps.
The system is fully modular. It is designed by encapsulating several functions in separated components with easy-to-understand APIs.
We provided some code snippets to understand the core functionalities of this system.

OpenVSLAM is based on an indirect SLAM algorithm with sparse features, such as ORB-SLAM, ProSLAM, and UcoSLAM. One of the noteworthy features of OpenVSLAM is that the system can deal with various type of camera models, such as perspective, fisheye, and equirectangular. If needed, users can implement extra camera models (e.g. dual fisheye, catadioptric) with ease. For example, visual SLAM algorithm using equirectangular camera models (e.g. RICOH THETA series, insta360 series, etc) is shown above.

Some code snippets to understand the core functionalities of the system are provided. You can employ these snippets for in your own programs. Please see the *.cc files in ./example directory or check Simple Tutorial and Example.

We provided documentation for installation and tutorial. Please contact us via GitHub issues if you have any questions or notice any bugs about the software.

Motivation

Visual SLAM is regarded as a next-generation technology for supporting industries such as automotives, robotics, and xR. We released OpenVSLAM as an opensource project with the aim of collaborating with people around the world to accelerate the development of this field. In return, we hope this project will bring safe and reliable technologies for a better society.

Installation

Please see Installation chapter in the documentation.

The instructions for Docker users are also provided.

Tutorial

Please see Simple Tutorial chapter in the documentation.

A sample ORB vocabulary file can be downloaded from here. Sample datasets are also provided at here.

If you would like to run visual SLAM with standard benchmarking datasets (e.g. KITTI Odometry dataset), please see SLAM with standard datasets section in the documentation.

Community

If you want to join our Slack community, please fill out the application form from the following site(s):

http://bit.ly/openvslam
http://bit.ly/openvslam-jp (日本語: in Japanese)

Currently working on

IMU integration
Python bindings
Implementation of extra camera models
Refactoring

Feedbacks, feature requests, and contribution are welcome!

License

2-clause BSD license (see LICENSE)

The following files are derived from third-party libraries.

./3rd/json : nlohmann/json [v3.6.1] (MIT license)
./3rd/popl : badaix/popl [v1.2.0] (MIT license)
./3rd/spdlog : gabime/spdlog [v1.3.1] (MIT license)
./src/openvslam/solver/pnp_solver.cc : part of laurentkneip/opengv (3-clause BSD license)
./src/openvslam/feature/orb_extractor.cc : part of opencv/opencv (3-clause BSD License)
./src/openvslam/feature/orb_point_pairs.h : part of opencv/opencv (3-clause BSD License)
./viewer/public/js/lib/dat.gui.min.js : dataarts/dat.gui (Apache License 2.0)
./viewer/public/js/lib/protobuf.min.js : protobufjs/protobuf.js (3-clause BSD License)
./viewer/public/js/lib/stats.min.js : mrdoob/stats.js (MIT license)
./viewer/public/js/lib/three.min.js : mrdoob/three.js (MIT license)

Please use g2o as the dynamic link library because csparse_extension module of g2o is LGPLv3+.

Contributors

Shinya Sumikura (@shinsumicco)
Mikiya Shibuya (@MikiyaShibuya)
Ken Sakurada (@kensakurada)

Citation

OpenVSLAM won first place at ACM Multimedia 2019 Open Source Software Competition.

If OpenVSLAM helps your research, please cite the paper for OpenVSLAM. Here is a BibTeX entry:

@inproceedings{openvslam2019,
  author = {Sumikura, Shinya and Shibuya, Mikiya and Sakurada, Ken},
  title = {{OpenVSLAM: A Versatile Visual SLAM Framework}},
  booktitle = {Proceedings of the 27th ACM International Conference on Multimedia},
  series = {MM '19},
  year = {2019},
  isbn = {978-1-4503-6889-6},
  location = {Nice, France},
  pages = {2292--2295},
  numpages = {4},
  url = {http://doi.acm.org/10.1145/3343031.3350539},
  doi = {10.1145/3343031.3350539},
  acmid = {3350539},
  publisher = {ACM},
  address = {New York, NY, USA}
}

The preprint can be found here.

Reference

Raúl Mur-Artal, J. M. M. Montiel, and Juan D. Tardós. 2015. ORB-SLAM: a Versatile and Accurate Monocular SLAM System. IEEE Transactions on Robotics 31, 5 (2015), 1147–1163.
Raúl Mur-Artal and Juan D. Tardós. 2017. ORB-SLAM2: an Open-Source SLAM System for Monocular, Stereo and RGB-D Cameras. IEEE Transactions on Robotics 33, 5 (2017), 1255–1262.
Dominik Schlegel, Mirco Colosi, and Giorgio Grisetti. 2018. ProSLAM: Graph SLAM from a Programmer’s Perspective. In Proceedings of IEEE International Conference on Robotics and Automation (ICRA). 1–9.
Rafael Muñoz-Salinas and Rafael Medina Carnicer. 2019. UcoSLAM: Simultaneous Localization and Mapping by Fusion of KeyPoints and Squared Planar Markers. arXiv:1902.03729.
Mapillary AB. 2019. OpenSfM. https://github.com/mapillary/OpenSfM.
Giorgio Grisetti, Rainer Kümmerle, Cyrill Stachniss, and Wolfram Burgard. 2010. A Tutorial on Graph-Based SLAM. IEEE Transactions on Intelligent Transportation SystemsMagazine 2, 4 (2010), 31–43.
Rainer Kümmerle, Giorgio Grisetti, Hauke Strasdat, Kurt Konolige, and Wolfram Burgard. 2011. g2o: A general framework for graph optimization. In Proceedings of IEEE International Conference on Robotics and Automation (ICRA). 3607–3613.

chunyang-zhang/openvslam