search

ethz-asl / panoptic_mapping

A flexible submap-based framework towards spatio-temporally consistent volumetric mapping and scene understanding.
BSD 3-Clause "New" or "Revised" License
275 stars 31 forks source link
consistent mapping multi-tsdfs panoptic panoptic-mapping semantic temporal volumetric

readme

Ubuntu 18 + ROS Melodic Ubuntu 20 + ROS Noetic Docker

Panoptic Mapping

This package contains panoptic_mapping, a general framework for semantic volumetric mapping. We provide, among other, a submap-based approach that leverages panoptic scene understanding towards adaptive spatio-temporally consistent volumetric mapping, as well as regular, monolithic semantic mapping.

combined

Multi-resolution 3D Reconstruction, active and inactive panoptic submaps for temporal consistency, online change detection, and more.

Table of Contents

Credits

Setup

Examples

Other

Paper

If you find this package useful for your research, please consider citing our paper:

Video

For a short overview explaining the approach check out our video on youtube:

youtube video

Installation

Instructions for different installation options. The repository was developed and tested on Ubuntu 18.04 with ROS melodic and Ubuntu 20.04 with ROS noetic.

Docker To run the panoptic mapper without installation, just use the docker image:

docker pull ghcr.io/ethz-asl/panoptic_mapping:main
docker run -it ghcr.io/ethz-asl/panoptic_mapping:main bash

VSCode For development with vscode, you can just clone this repository and follow the prompts to open it in a devcontainer.

System Installation To install on linux, follow the instructions below matching your OS and ROS version:

Ubuntu 18.04 + ROS Melodic.

**Prerequisites** 1. If not already done so, install [ROS](http://wiki.ros.org/ROS/Installation) (Desktop-Full is recommended). 2. If not already done so, create a catkin workspace with [catkin tools](https://catkin-tools.readthedocs.io/en/latest/): ```shell script sudo apt-get install python-catkin-tools mkdir -p ~/catkin_ws/src cd ~/catkin_ws catkin init catkin config --extend /opt/ros/melodic catkin config --cmake-args -DCMAKE_BUILD_TYPE=RelWithDebInfo catkin config --merge-devel ``` **Installation** 1. Install system dependencies: ```shell script sudo apt-get install python-wstool python-catkin-tools autoconf libtool git ``` 2. Move to your catkin workspace: ```shell script cd ~/catkin_ws/src ``` 3. Download repo using [SSH](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh) or HTTPS: ```shell script git clone git@github.com:ethz-asl/panoptic_mapping.git # SSH git clone https://github.com/ethz-asl/panoptic_mapping.git # HTTPS ``` 4. Download and install package dependencies using ros install: * If you created a new workspace. ```shell script wstool init . ./panoptic_mapping/panoptic_mapping_ssh.rosinstall # SSH wstool init . ./panoptic_mapping/panoptic_mapping_https.rosinstall # HTTPS wstool update ``` * If you use an existing workspace. Notice that some dependencies require specific branches that will be checked out. ```shell script wstool merge -t . ./panoptic_mapping/panoptic_mapping.rosinstall wstool update ``` 5. Compile and source: ```shell script catkin build panoptic_mapping_utils source ../devel/setup.bash ```

Ubuntu 20.04 + ROS Noetic.

**Prerequisites** 1. If not already done so, install [ROS](http://wiki.ros.org/ROS/Installation) (Desktop-Full is recommended). 2. If not already done so, create a catkin workspace with [catkin tools](https://catkin-tools.readthedocs.io/en/latest/): ```shell script sudo apt-get install python3-catkin-tools mkdir -p ~/catkin_ws/src cd ~/catkin_ws catkin init catkin config --extend /opt/ros/noetic catkin config --cmake-args -DCMAKE_BUILD_TYPE=RelWithDebInfo catkin config --merge-devel ``` **Installation** 1. Install system dependencies: ```shell script sudo apt-get install python3-pip python3-wstool python3-catkin-tools autoconf libtool git pip3 install osrf-pycommon ``` 2. Move to your catkin workspace: ```shell script cd ~/catkin_ws/src ``` 3. Download repo using [SSH](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh) or HTTPS: ```shell script git clone git@github.com:ethz-asl/panoptic_mapping.git # SSH git clone https://github.com/ethz-asl/panoptic_mapping.git # HTTPS ``` 4. Download and install package dependencies using ros install: * If you created a new workspace. ```shell script wstool init . ./panoptic_mapping/panoptic_mapping_ssh.rosinstall # SSH wstool init . ./panoptic_mapping/panoptic_mapping_https.rosinstall # HTTPS wstool update ``` * If you use an existing workspace. Notice that some dependencies require specific branches that will be checked out. ```shell script wstool merge -t . ./panoptic_mapping/panoptic_mapping.rosinstall wstool update ``` 5. Compile and source: ```shell script catkin build panoptic_mapping_utils source ../devel/setup.bash ```

Datasets

The datasets described in the paper and used for the demo can be downloaded from the ASL Datasets.

A utility script is provided to directly download the flat data:

roscd panoptic_mapping_utils
export FLAT_DATA_DIR="/home/$USER/Documents"  # Or whichever path you prefer.
chmod +x panoptic_mapping_utils/scripts/download_flat_dataset.sh
./panoptic_mapping_utils/scripts/download_flat_dataset.sh

To run the RIO demos, the original dataset needs to be downloaded and augmented with our supplementary data. Instructions on which scenes to download and how to combine them are found on our dataset page.

Examples

Running the Panoptic Mapper

This example explains how to run the Panoptic Multi-TSDF mapper on the flat dataset.

  1. First, download the flat dataset:

    export FLAT_DATA_DIR="/home/$USER/Documents"  # Or whichever path you prefer.
chmod +x panoptic_mapping_utils/scripts/download_flat_dataset.sh
./panoptic_mapping_utils/scripts/download_flat_dataset.sh

  2. Replace the data base_path in launch/run.launch (L10) and file_name in config/mapper/flat_groundtruth.yaml (L15) to the downloaded path.

  3. Run the mapper:

    roslaunch panoptic_mapping_ros run.launch

  4. You should now see the map being incrementally built:

  5. After the map finished building, you can save the map:

    rosservice call /panoptic_mapper/save_map "file_path: '/path/to/run1.panmap'"

  6. Terminate the mapper pressing Ctrl+C. You can continue the experiment on run2 of the flat dataset by changing the base_path-ending in launch/run.launch (L10) to run2, and load_map and load_path in launch/run.launch (L26-27) to true and /path/to/run1.panmap, respectively. Optionally, you can also change the color_mode in config/mapper/flat_groundtruth.yaml (L118) to change to better highlight the change detection at work.

    roslaunch panoptic_mapping_ros run.launch

  7. You should now see the map being updated based on the first run:

Monolithic Semantic Mapping

Panoptic Mapping supports also the monolithic use case. This example explains how to run the Panoptic Single-TSDF mapper on the flat dataset.

  1. If not already done so, download the flat dataset:

    export FLAT_DATA_DIR="/home/$USER/Documents"  # Or whichever path you prefer.
chmod +x panoptic_mapping_utils/scripts/download_flat_dataset.sh
./panoptic_mapping_utils/scripts/download_flat_dataset.sh

  2. Replace the data base_path in launch/run.launch (L10) and file_name in config/mapper/single_tsdf.yaml (L15) to the downloaded path.

  3. To use the single-TSDF mapper and real segmentation predictions, set use_detectron in launch/run.launch (L6) to true and config in launch/run.launch (L22) to 'single_tsdf'.

  4. Run the mapper:

    roslaunch panoptic_mapping_ros run.launch

  5. You should now see the map being incrementally built.

  6. Varying visualization modes are supported, the classes (default) will color the mesh according to the predicted semantic class. Other modes, such as classification will show the confidence of the aggregated predictions.

single_combined

Predicted classes (left) and corresponding fusion confidence (right, low to high in red to green).

Running the RIO Dataset

This example explains how to run the Panoptic Multi-TSDF mapper on the RIO dataset.

  1. First, download the original dataset and our supplementary data.

  2. Set use_rio in launch/run.launch (L5) to true, replace the data_path in (L16) and file_name in config/mapper/rio_groundtruth.yaml (L15) to the downloaded path.

  3. Run the mapper:

    roslaunch panoptic_mapping_ros run.launch

  4. You should now see the map being incrementally built:

    (Left in reconstructed color, right colored by submap)

Contributing

panoptic_mapping is an open-source project, any contributions are welcome!

For issues, bugs, or suggestions, please open a GitHub Issue.

To add to this repository: