Awesome

Loosely-Coupled Semi-Direct Monocular SLAM

Paper: https://arxiv.org/abs/1807.10073

Supplementary Material: Here

Video demo: https://youtu.be/j7WnU7ZpZ8c

:large_blue_diamond: 1. Raw Results and MATLAB Scripts (for figures).

Run main.m after setting appropriate paths and mode:

Mode 1: Plot pre-evaluated results to make the same figures in the paper.
Mode 2: Process your own results and plot.
Mode 3: Plot your processed results (if you've already run with mode=2).

:large_blue_diamond: 2. C++ Source Code

2.1. License

Our source-code is licensed under the GNU General Public License Version 3 (GPLv3).

2.2. Prerequisites

Our implementation is based on ORB-SLAM2 and DSO. So please install the required (and recommended) dependencies for each project first. These are: ROS, C++11 compiler, suitesparse, eigen3, Pangolin, and OpenCV. The instructions can be found in their original project pages. We tested our code using Ubuntu 14.04 (ROS Indigo) and Ubuntu 16.04 (ROS Kinetic).

2.3. How to build:

Install ROS.
Install dependencies:

sudo apt-get install libsuitesparse-dev libeigen3-dev libboost-all-dev libopencv-dev

Install Pangolin.
Install ziplib (recommended)

sudo apt-get install zlib1g-dev
cd ~/LCSD_SLAM/DSO/thirdparty
tar -zxvf libzip-1.1.1.tar.gz
cd libzip-1.1.1/
./configure
make
sudo make install
sudo cp lib/zipconf.h /usr/local/include/zipconf.h

Build!

cd [YOUR_PATH]/LCSD_SLAM
chmod +x build.sh

// In build.sh, change line 1 and 40 by replacing "~/LCSD_SLAM" to "[YOUR_PATH]/LCSD_SLAM"
./build.sh

2.4. How to run:

(1) Enable/Disable visualization (GUI):

(a) GUI for the direct module (DSO): Go to DSO_ROS/catkin_ws/src/dso_ros/launch/euroc_***.launch (for the EuRoC MAV dataset) or DSO_ROS/catkin_ws/src/dso_ros/launch/monoVO_***.launch (for the TUM monoVO dataset) and set display_GUI to either true or false.

(b) GUI for the feature-based module (ORB-SLAM): Go to ORB_SLAM2/Examples/Monocular/EuRoC_seong_***.yaml (for the EuRoC MAV dataset) or ORB_SLAM2/Examples/Monocular/TUMmonoVO_yaml/TUM_monoVO_***.yaml (for the TUM monoVO dataset) and set GUI to either 1 or 0.

Note that enabling both GUIs can slow down the performance. The results reported in the paper were obtained by running the system with both GUIs disabled. If you really want the optimal result with the visualization, reduce the playback speed by half (see next) and enable the GUI of ORB-SLAM only.

(2) Set the playback speed and paths:

This can be done by setting the parameter value of playback_speed in the launch file in DSO_ROS (see Step 1(a)). The default is 1 (original speed).

Also, edit the input paths (image_file_path, calib_file_path, vignette_file_path, gamma_file_path) and the output path (stats_file_path).

For TUM_monoVO dataset, the four input paths should be directed to images.zip, camera.txt, vignette.png, pcalib.txt provided by the dataset.

For EuRoC dataset, the image_file_path should be directed to the folder containg the images, and calib_file_path should be directed to either cam0_calib_for_dso.txt or cam1_calib_for_dso.txt provided here and here.

(3) [For datasets other than TUM_monoVO only, e.g., EuRoC MAV or KITTI] Create times.txt

You need to provide the timestamp data separately. Create times.txt and write the image timestamps in one column (the unit doesn't matter). Make sure you have the same number of timestamps as the number of images in image_file_path. Then move this file to the same directory where your image_file_path is located.

Example with EuRoC_MAV dataset:

MH_01_easy
|
└─── cam0
     |    times.txt
     |
     └─── data  #This is your image_file_path
          |   img0.png
          |   img1.png
          |   ...

(4) Run:

(i) In the first terminal, run roscore

(ii) In the second terminal, run

cd [YOUR_PATH]/LCSD_SLAM/ORB_SLAM2

// For the EuRoC MAV dataset:
rosrun ORB_SLAM2 Mono Vocabulary/ORBvoc.txt \
Examples/Monocular/EuRoC_seong_[VO/SLAM]_cam[0/1].yaml 

// For the TUM monoVO dataset:
rosrun ORB_SLAM2 Mono Vocabulary/ORBvoc.txt \
Examples/Monocular/TUMmonoVO_yaml/monoVO_ORB_[VO/SLAM]_full_[SEQUENCE_NUMBER].yaml

(iii) In the third terminal, run

cd [YOUR_PATH]/DSO_ROS/catkin_ws
source devel/setup.bash

// For the EuRoC MAV dataset (see launch files in LCSD_SLAM/DSO_ROS/catkin_ws/src/dso_ros/launch):
roslaunch dso_ros EuRoC_seong_[SEQUENCE_NAME]_cam[0/1].launch 

// For the TUM monoVO dataset (see launch files in LCSD_SLAM/DSO_ROS/catkin_ws/src/dso_ros/launch):
roslaunch dso_ros monoVO_seong_[SEQUENCE_NUMBER].launch

The keyframe trajectory will be saved as KeyFrameTrajectory_seong.txt in ORB_SLAM2 folder, and additional tracking statistics will be saved as trackingStats.txt in the path you set (stats_file_path) in Step 3.

2.4. Important source files:

ros_output_wraper.cpp: Collects the marginalized data from DSO
dso_node.cpp: Runs DSO and sends the marginalized data to ORB-SLAM.
ros_mono.cc: Runs ORB-SLAM and receives the marginalized data from DSO.
Tracking.cc: Performs motion-only geometric BA using the initial pose estimate from DSO. Also, it decides whether or not the new keyframe should be inserted (and more points from DSO be added).
LocalMapping.cc: Performs joint geometric BA and checks the collinearity of the covisibility links between keyframes.