Skip to content

Commit 3443703

Browse files
docs(planning): fix path to documents (#7233)
* docs(avoidance): fix path to documents Signed-off-by: Zulfaqar Azmi <zulfaqar.azmi@tier4.jp> * fix naming Signed-off-by: Zulfaqar Azmi <zulfaqar.azmi@tier4.jp> * fix velocity smoother and add remaining dist time calculator Signed-off-by: Zulfaqar Azmi <zulfaqar.azmi@tier4.jp> --------- Signed-off-by: Zulfaqar Azmi <zulfaqar.azmi@tier4.jp>
1 parent 4daa6a9 commit 3443703

File tree

5 files changed

+13
-12
lines changed

5 files changed

+13
-12
lines changed

planning/.pages

+6-5
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ nav:
1010
- 'Dynamic Drivable Area': planning/behavior_path_planner_common/docs/behavior_path_planner_drivable_area_design
1111
- 'Turn Signal': planning/behavior_path_planner_common/docs/behavior_path_planner_turn_signal_design
1212
- 'Scene Module':
13-
- 'Avoidance': planning/behavior_path_avoidance_module
1413
- 'Avoidance by Lane Change': planning/behavior_path_avoidance_by_lane_change_module
15-
- 'Dynamic Avoidance': planning/behavior_path_dynamic_avoidance_module
14+
- 'Dynamic Obstacle Avoidance': planning/autoware_behavior_path_dynamic_obstacle_avoidance_module
1615
- 'Goal Planner': planning/behavior_path_goal_planner_module
1716
- 'Lane Change': planning/behavior_path_lane_change_module
1817
- 'Side Shift': planning/behavior_path_side_shift_module
1918
- 'Start Planner': planning/behavior_path_start_planner_module
19+
- 'Static Obstacle Avoidance': planning/autoware_behavior_path_static_obstacle_avoidance_module
2020
- 'Behavior Velocity Planner':
2121
- 'About Behavior Velocity': planning/autoware_behavior_velocity_planner
2222
- 'Template for Custom Module': planning/autoware_behavior_velocity_template_module
@@ -67,9 +67,9 @@ nav:
6767
- 'About Motion Velocity Planner': planning/autoware_motion_velocity_planner_node/
6868
- 'Available Modules':
6969
- 'Out of Lane': planning/autoware_motion_velocity_planner_out_of_lane_module/
70-
- 'Motion Velocity Smoother':
71-
- 'About Motion Velocity Smoother': planning/motion_velocity_smoother
72-
- 'About Motion Velocity Smoother (Japanese)': planning/motion_velocity_smoother/README.ja
70+
- 'Velocity Smoother':
71+
- 'About Velocity Smoother': planning/autoware_velocity_smoother
72+
- 'About Velocity Smoother (Japanese)': planning/autoware_velocity_smoother/README.ja
7373
- 'Scenario Selector': planning/scenario_selector
7474
- 'Static Centerline Generator': planning/autoware_static_centerline_generator
7575
- 'API and Library':
@@ -79,6 +79,7 @@ nav:
7979
- 'Route Handler': planning/route_handler
8080
- 'RTC Interface': planning/rtc_interface
8181
- 'Additional Tools':
82+
- 'Remaining Distance Time Calculator': planning/autoware_remaining_distance_time_calculator
8283
- 'RTC Replayer': planning/rtc_replayer
8384
- 'Planning Debug Tools':
8485
- 'About Planning Debug Tools': https://github.com/autowarefoundation/autoware_tools/tree/main/planning/planning_debug_tools

planning/autoware_behavior_path_dynamic_obstacle_avoidance_module/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ Each module performs the following roles.
99
Dynamic Avoidance module cuts off the drivable area according to the position and velocity of the target to be avoided.
1010
Obstacle Avoidance module modifies the path to be followed so that it fits within the received drivable area.
1111

12-
Avoidance functions are also provided by the [Avoidance module](https://autowarefoundation.github.io/autoware.universe/main/planning/behavior_path_avoidance_module/), but these modules have different roles.
13-
The Avoidance module performs avoidance through the outside of own lanes but cannot avoid the moving objects.
12+
Static obstacle's avoidance functions are also provided by the [Static Avoidance module](https://autowarefoundation.github.io/autoware.universe/main/planning/autoware_behavior_path_static_obstacle_avoidance_module/), but these modules have different roles.
13+
The Static Obstacle Avoidance module performs avoidance through the outside of own lanes but cannot avoid the moving objects.
1414
On the other hand, this module can avoid moving objects.
1515
For this reason, the word "dynamic" is used in the module's name.
1616
The table below lists the avoidance modules that can handle each situation.

planning/autoware_behavior_path_static_obstacle_avoidance_module/schema/static_obstacle_avoidance.schema.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
22
"$schema": "http://json-schema.org/draft-07/schema#",
3-
"title": "Parameters for behavior_path_avoidance_module",
3+
"title": "Parameters for behavior_path_static_obstacle_avoidance_module",
44
"type": "object",
55
"definitions": {
6-
"behavior_path_avoidance_module": {
6+
"behavior_path_static_obstacle_avoidance_module": {
77
"type": "object",
88
"properties": {
99
"resample_interval_for_planning": {
@@ -1473,7 +1473,7 @@
14731473
"type": "object",
14741474
"properties": {
14751475
"avoidance": {
1476-
"$ref": "#/definitions/behavior_path_avoidance_module"
1476+
"$ref": "#/definitions/behavior_path_static_obstacle_avoidance_module"
14771477
}
14781478
},
14791479
"required": ["avoidance"],

planning/behavior_path_avoidance_by_lane_change_module/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This module is designed as one of the obstacle avoidance features and generates
1313

1414
## Inner-workings / Algorithms
1515

16-
Basically, this module is implemented by reusing the avoidance target filtering logic of the existing [Normal Avoidance Module](../behavior_path_avoidance_module/README.md) and the path generation logic of the [Normal Lane Change Module](../behavior_path_lane_change_module/README.md). On the other hand, the conditions under which the module is activated differ from those of a normal avoidance module.
16+
Basically, this module is implemented by reusing the avoidance target filtering logic of the existing [Static Object Avoidance Module](../autoware_behavior_path_static_obstacle_avoidance_module/README.md) and the path generation logic of the [Normal Lane Change Module](../behavior_path_lane_change_module/README.md). On the other hand, the conditions under which the module is activated differ from those of a normal avoidance module.
1717

1818
Check that the following conditions are satisfied after the filtering process for the avoidance target.
1919

planning/behavior_path_lane_change_module/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ First, we divide the target objects into obstacles in the target lane, obstacles
296296

297297
![object lanes](./images/lane_objects.drawio.svg)
298298

299-
Furthermore, to change lanes behind a vehicle waiting at a traffic light, we skip the safety check for the stopping vehicles near the traffic light. The explanation for parked car detection is written in [documentation for avoidance module](../behavior_path_avoidance_module/README.md).
299+
Furthermore, to change lanes behind a vehicle waiting at a traffic light, we skip the safety check for the stopping vehicles near the traffic light. The explanation for parked car detection is written in [documentation for avoidance module](../autoware_behavior_path_static_obstacle_avoidance_module/README.md).
300300

301301
The detection area for the target lane can be expanded beyond its original boundaries to enable detection of objects that are outside the target lane's limits.
302302

0 commit comments

Comments
 (0)