Skip to content

Commit d87ef44

Browse files
committed
Add documentation for ground consistency layer
Signed-off-by: haider8645 <haider_lodhi@hotmail.com>
1 parent 626d018 commit d87ef44

6 files changed

Lines changed: 10 additions & 3 deletions

File tree

plugins/index.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,11 @@ Costmap Layers
8181
| | | costmap with different isolated |
8282
| | | combinations of costmap layers |
8383
+--------------------------------+------------------------+----------------------------------+
84+
| `Ground Consistency Layer`_ | Muhammad Haider Khan | Height-aware costmap layer using |
85+
| | Lodhi | 3D ground segmentation. Pair |
86+
| | | with Inflation Layer for terrain-|
87+
| | | aware navigation. |
88+
+--------------------------------+------------------------+----------------------------------+
8489

8590
.. _Voxel Layer: https://github.com/ros-navigation/navigation2/tree/main/nav2_costmap_2d/plugins/voxel_layer.cpp
8691
.. _Static Layer: https://github.com/ros-navigation/navigation2/tree/main/nav2_costmap_2d/plugins/static_layer.cpp
@@ -92,6 +97,7 @@ Costmap Layers
9297
.. _Non-Persistent Voxel Layer: https://github.com/SteveMacenski/nonpersistent_voxel_layer
9398
.. _Denoise Layer: https://github.com/ryzhikovas/navigation2/tree/feature-costmap2d-denoise/nav2_costmap_2d/plugins/denoise_layer.cpp
9499
.. _Plugin Container Layer: https://github.com/ros-navigation/navigation2/tree/main/nav2_costmap_2d/plugins/plugin_container_layer.cpp
100+
.. _Ground Consistency Layer: https://github.com/dfki-ric/nav2_ground_consistency_costmap_plugin
95101

96102
Costmap Filters
97103
===============
7.67 MB
Loading
484 KB
Loading
27.3 KB
Loading

tutorials/docs/navigation_with_ground_consistency_layer.rst renamed to tutorials/docs/navigation2_with_ground_consistency_layer.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ NAV2 Ground Consistency Demo
44

55
A tutorial demonstrating terrain-aware navigation using 3D lidar ground segmentation with Nav2's `ground consistency costmap layer <https://github.com/dfki-ric/nav2_ground_consistency_costmap_plugin>`_. Learn how to classify terrain into traversable ground and obstacles, then use that classification to build smarter costmaps for safer navigation.
66

7-
.. image:: media/ground_consistency_layer.gif
7+
.. image:: images/Navigation2_with_Ground_Consistency/ground_consistency_layer.gif
88
:alt: Ground Consistency Layer Demo
99

1010
Overview
@@ -150,7 +150,7 @@ You should see:
150150
- Husky robot appears on the ground
151151
- ROS topics ``/husky/scan/points``, ``/husky/imu`` being published
152152

153-
.. image:: media/husky_in_baylands.png
153+
.. image:: images/Navigation2_with_Ground_Consistency/husky_in_baylands.png
154154
:alt: Husky in Baylands
155155

156156
Verify the lidar is working:
@@ -161,7 +161,7 @@ Verify the lidar is working:
161161
162162
You should see ~5-10 Hz updates based on your computer specifications. You will need to set your rviz 'Frame Rate' to this value to avoid issues with rviz visualizations.
163163

164-
.. image:: media/rviz_frame_settings.png
164+
.. image:: images/Navigation2_with_Ground_Consistency/rviz_frame_settings.png
165165
:alt: RViz Frame Settings
166166

167167
Step 2: Launch Navigation Stack

tutorials/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,4 @@ Nav2 Tutorials
3333
docs/navigation2_with_vector_objects.rst
3434
docs/roscon_uk_2025_state_estimation.rst
3535
docs/using_3laws_supervisor.rst
36+
docs/navigation2_with_ground_consistency_layer.rst

0 commit comments

Comments
 (0)