Skip to content

Commit da1e5cd

Browse files
Improve clarity of Costmap2D parameter documentation (#889)
* Improve clarity of costmap parameter descriptions Signed-off-by: tarunkumar <tarunkotian10@gmail.com> * Improve clarity of Costmap2D parameter documentation Signed-off-by: tarunkumar <tarunkotian10@gmail.com> * Improve clarity of Costmap2D parameter documentation Signed-off-by: tarunkumar <tarunkotian10@gmail.com> --------- Signed-off-by: tarunkumar <tarunkotian10@gmail.com>
1 parent a657299 commit da1e5cd

1 file changed

Lines changed: 13 additions & 6 deletions

File tree

configuration/packages/configuring-costmaps.rst

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Costmap2D ROS Parameters
2222
============== =======
2323

2424
Description
25-
Whether to send full costmap every update, rather than updates.
25+
Whether to send the full costmap on every update instead of only incremental updates.
2626

2727
:introspection_mode:
2828

@@ -121,7 +121,7 @@ Costmap2D ROS Parameters
121121
============== =======
122122

123123
Description
124-
The height of map, allows to avoid rviz visualization flickering at -0.008
124+
The height of the map used for visualization, helping to avoid RViz flickering issues (e.g., at -0.008).
125125

126126
:origin_x:
127127

@@ -154,7 +154,8 @@ Costmap2D ROS Parameters
154154
============== =======
155155

156156
Description
157-
Frequency to publish costmap to topic.
157+
Frequency (Hz) at which the costmap is published to a topic.
158+
Higher values provide more frequent updates for visualization and debugging but increase bandwidth usage.
158159

159160
:resolution:
160161

@@ -165,7 +166,9 @@ Costmap2D ROS Parameters
165166
============== =======
166167

167168
Description
168-
Resolution of 1 pixel of the costmap, in meters.
169+
Resolution of each cell (pixel) in the costmap, in meters.
170+
Smaller values increase map accuracy and obstacle detail but require more computation.
171+
Larger values reduce computational load but may miss fine obstacles.
169172

170173
:robot_base_frame:
171174

@@ -209,7 +212,9 @@ Costmap2D ROS Parameters
209212
============== =======
210213

211214
Description
212-
Whether costmap should roll with robot base frame.
215+
If true, the costmap moves with the robot, maintaining a local view centered around it.
216+
This is typically used for local costmaps.
217+
If false, the costmap remains fixed in the global frame.
213218

214219
:track_unknown_space:
215220

@@ -297,7 +302,9 @@ Costmap2D ROS Parameters
297302
============== =======
298303

299304
Description
300-
whether when combining costmaps to use the maximum cost or override.
305+
Whether to use the maximum cost when combining multiple costmap layers.
306+
If true, the highest cost is preserved, ensuring obstacles are not overwritten.
307+
If false, newer layers may override previous cost values.
301308

302309
:plugins:
303310

0 commit comments

Comments
 (0)