wangleislam / kimera-semantics

Real-Time 3D Semantic Reconstruction from 2D data

Kimera-Semantics

Publications

We kindly ask to cite our paper if you find this library useful:

• A. Rosinol, M. Abate, Y. Chang, L. Carlone. Kimera: an Open-Source Library for Real-Time Metric-Semantic Localization and Mapping. arXiv preprint arXiv:1910.02490.

@misc{Rosinol19arxiv-Kimera,
  title = {Kimera: an Open-Source Library for Real-Time Metric-Semantic Localization and Mapping},
  author = {Rosinol, Antoni and Abate, Marcus and Chang, Yun and Carlone, Luca},
  year = {2019},
  eprint = {1910.02490},
  archiveprefix = {arXiv},
  primaryclass = {cs.RO},
  url = {https://github.com/MIT-SPARK/Kimera},
  pdf = {https://arxiv.org/pdf/1910.02490.pdf}
}

Related publications

Our work is built using Voxblox:

Helen Oleynikova, Zachary Taylor, Marius Fehr, Juan Nieto, and Roland Siegwart, Voxblox: Incremental 3D Euclidean Signed Distance Fields for On-Board MAV Planning, in IEEE/RSJ International Conference on Intelligent Robots and Systems (IROS), 2016.

1. Installation

A. Prerequisities

• Install ROS by following our reference, or the official ROS website.

• Install system dependencies:

sudo apt-get install python-wstool python-catkin-tools  protobuf-compiler autoconf
# Change `melodic` below for your own ROS distro
sudo apt-get install ros-melodic-cmake-modules

B. Kimera-Semantics Installation

Using catkin:

# Setup catkin workspace
mkdir -p ~/catkin_ws/src
cd ~/catkin_ws/
catkin init
catkin config --extend /opt/ros/melodic # Change `melodic` to your ROS distro
catkin config --cmake-args -DCMAKE_BUILD_TYPE=Release
catkin config --merge-devel

# Add workspace to bashrc.
echo 'source ~/catkin_ws/devel/setup.bash' >> ~/.bashrc

# Clone repo
cd ~/catkin_ws/src
git clone [email protected]:MIT-SPARK/Kimera-Semantics.git

# Install dependencies from rosinstall file using wstool
wstool init # Use unless wstool is already initialized

# For ssh:
wstool merge Kimera-Semantics/kimera/install/kimera_semantics_ssh.rosinstall
# For https:
#wstool merge Kimera-Semantics/kimera/install/kimera_semantics_https.rosinstall

# Download and update all dependencies
wstool update

Finally, compile:

# Compile code
catkin build kimera

# Refresh workspace
source ~/catkin_ws/devel/setup.bash

2. Usage

0. Download the demo rosbag (click here to download) and save it inside the rosbag folder in the kimera folder: ./kimera/rosbag/kimera_semantics_demo.bag.

1. As a general good practice, open a new terminal and run: roscore

2. In another terminal, launch the provided rosbag (click here to download):

rosbag play --clock --pause $(rosstack find kimera)/rosbags/kimera_semantics_demo.bag

3. In another terminal, launch Kimera-Semantics:

roslaunch kimera_semantics_ros kimera_semantics.launch

4. In another terminal, launch rviz for visualization:

rviz -d $(rospack find kimera_semantics_ros)/rviz/kimera_semantics_gt.rviz

Now, go back to the terminal where the rosbag was launched and just press space to run the rosbag.

Note: you will need to source your catkin_ws for each new terminal unless you added the following line to your ~/.bashrc file:

source ~/catkin_ws/devel/setup.bash # Change `bash` to the shell you use.

Note 2: you might need to check/uncheck once the Kimera Semantic 3D Mesh left pane topic in rviz.

3. FAQ

• Minkindr doesn't compile: Catkin ignore the minkindr_python catkin package:

  touch ~/catkin_ws/src/minkindr/minkindr_python/CATKIN_IGNORE