Skip to content

Commit

Permalink
added some info about octomap
Browse files Browse the repository at this point in the history
  • Loading branch information
pritzvac committed Nov 29, 2024
1 parent 3419793 commit a552444
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 5 deletions.
19 changes: 15 additions & 4 deletions docs/50-features/55-octomap/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ import DocCardList from '@theme/DocCardList';

<DocCardList />

TODO description
3D volumetric mapping based on Octomap + A*-based planning

<Button label="🔗 mrs_octomap_mapping_planning repository" link="https://github.com/ctu-mrs/mrs_octomap_mapping_planning/tree/master" block /><br />

## Dependencies

Expand All @@ -21,10 +23,11 @@ TODO description

## Packages

* mrs_octomap_mapping_planning - launch files, example tmux session
* [mrs_octomap_mapping_planning](https://github.com/ctu-mrs/mrs_octomap_mapping_planning) - launch files, example tmux session
* [mrs_octomap_server](https://github.com/ctu-mrs/mrs_octomap_server) - Uses Octomap to build global & local map
* [mrs_octomap_planner](https://github.com/ctu-mrs/mrs_octomap_planner) - 3D planner for UAVs
* [mrs_octomap_tools](https://github.com/ctu-mrs/mrs_octomap_tools) - MRS Tools and libraries for Octomap
* [mrs_subt_planning_lib](https://github.com/ctu-mrs/mrs_subt_planning_lib) - 3D A*-based planner utilized by mrs_octomap_planner

## Example session

Expand All @@ -36,12 +39,20 @@ The [launch file](./ros_packages/mrs_octomap_mapping_planning/launch/mapplan.lau
```
roslaunch mrs_octomap_mapping_planning mapplan.launch
```
was prepared to launch
was prepared to utilize 3D LiDAR and depth camera data and to launch

* PointCloud filter ([mrs_pcl_tools](https://github.com/ctu-mrs/mrs_pcl_tools)),
* Octomap Server,
* Octomap Planner,
* Octomap RVIZ Visualizer,
* Nodelet manager.

Please, use provided arguments and custom config files to customize the behaviour of the nodes.
To use the launch file, you might need to:
- Specify reference frame of the map in the **world_frame_id** argument.
- Provide custom configs customizing the behavior of the PCL filters, octomap server, octomap planner, and octomap visualizer.
- Remap ROS topics expected by the launch file to correspond to your sensor configuration.

Example usage of the launch file with custom configs provided:
```
roslaunch mrs_octomap_mapping_planning mapplan.launch config_octomap_server:="./config/octomap.yaml" world_frame_id:="$UAV_NAME/mapping_origin" config_octomap_visualizer:="./config/octomap_rviz_visualizer.yaml" config_octomap_planner:="./config/pathfinder.yaml" config_pcl_filter_ouster:="./config/pcl_filter_mapping.yaml"
```
21 changes: 20 additions & 1 deletion docs/50-features/55-octomap/octomap_server.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,23 @@ description: Octomap Server

# Octomap server

TODO
<Button label="🔗 mrs_octomap_server repository" link="https://github.com/ctu-mrs/mrs_octomap_server" block /><br />

3D occupancy mapping based on [Octomap](https://octomap.github.io/). The sensor data are inserted into a local map centered at the current position of the robot. The local maps are periodically copied into a global map. The map can incorporate poinclouds from 3D LiDARs and depth cameras.

## Usage
See [octomap_mapping_planning launch file](https://github.com/ctu-mrs/mrs_octomap_mapping_planning/blob/master/ros_packages/mrs_octomap_mapping_planning/launch/mapplan.launch) for setting of relevant topics, passing a custom config to the octomap server and setting its parameters.

## Sensor topics
Topic names are set as arguments to the [launch file](https://github.com/ctu-mrs/mrs_octomap_server/blob/master/launch/octomap.launch).
| Topic name | Type | Meaning |
|--------------------------------------------|-------------------------|----------------------------------------------------------------------------------|
| lidar_3d_topic_*NUM*_in | sensor_msgs/PointCloud2 | 3D LiDAR poincloud |
| lidar_3d_topic_*NUM*_over_max_range_in | sensor_msgs/PointCloud2 | points over max range (will be used for free-space raycasting only |
| depth_camera_topic_*NUM*_in | sensor_msgs/PointCloud2 | depth camera pointcloud |
| depth_camera_topic_*NUM*_over_max_range_in | sensor_msgs/PointCloud2 | depth camera points over max range (will be used for free-space raycasting only |
| camera_info_topic_*NUM*_in | sensor_msgs/CameraInfo | depth camera info (used for calculating free-space raycasting parameters) |

## Configuration
The frame of reference, where the map is built, is set by argument **world_frame_id** of the launch file.
Default configuration parameters are available at [the config file](https://github.com/ctu-mrs/mrs_octomap_server/blob/master/config/default.yaml). They can be overriden by passing a custom config file to the main launch file.

0 comments on commit a552444

Please sign in to comment.