Skip to content

Commit b8e3bcb

Browse files
committed
docs: fix links to autoware_universe documentation
Signed-off-by: Ryohsuke Mitsudome <ryohsuke.mitsudome@tier4.jp>
1 parent de7ad75 commit b8e3bcb

File tree

9 files changed

+20
-20
lines changed
  • planning
    • autoware_path_optimizer
    • behavior_path_planner
      • autoware_behavior_path_dynamic_obstacle_avoidance_module
      • autoware_behavior_path_goal_planner_module
      • autoware_behavior_path_lane_change_module
    • behavior_velocity_planner
      • autoware_behavior_velocity_crosswalk_module
      • autoware_behavior_velocity_intersection_module
    • motion_velocity_planner/autoware_motion_velocity_planner_node_universe

9 files changed

+20
-20
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ To dive into the vast world of Autoware and understand how Autoware Universe fit
1313

1414
### Explore Autoware Universe documentation
1515

16-
For those looking to explore the specifics of Autoware Universe components, the [Autoware Universe Documentation](https://autowarefoundation.github.io/autoware.universe/), deployed with MKDocs, offers detailed insights.
16+
For those looking to explore the specifics of Autoware Universe components, the [Autoware Universe Documentation](https://autowarefoundation.github.io/autoware_universe/), deployed with MKDocs, offers detailed insights.
1717

1818
## Code Coverage Metrics
1919

mkdocs.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# To make changes, update the source repository and follow the guidelines in its README.
44

55
site_name: Autoware Universe Documentation
6-
site_url: https://autowarefoundation.github.io/autoware.universe
6+
site_url: https://autowarefoundation.github.io/autoware_universe
77
repo_url: https://github.com/autowarefoundation/autoware.universe
88
edit_uri: https://github.com/autowarefoundation/autoware.universe/edit/main/
99
docs_dir: .

planning/autoware_path_optimizer/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ Although it has a cons to converge to the local minima, it can get a good soluti
195195
- The point on the vehicle, offset forward with this parameter from the base link` tries to follow the reference path.
196196

197197
- change or tune the method to approximate footprints with a set of circles.
198-
- See [here](https://autowarefoundation.github.io/autoware.universe/main/planning/path_optimizer/docs/mpt/#collision-free)
198+
- See [here](https://autowarefoundation.github.io/autoware_universe/main/planning/path_optimizer/docs/mpt/#collision-free)
199199
- Tuning means changing the ratio of circle's radius.
200200

201201
### Computation time

planning/behavior_path_planner/autoware_behavior_path_dynamic_obstacle_avoidance_module/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ This module is under development.
44

55
## Purpose / Role
66

7-
This module provides avoidance functions for vehicles, pedestrians, and obstacles in the vicinity of the ego's path in combination with the [autoware_path_optimizer](https://autowarefoundation.github.io/autoware.universe/main/planning/autoware_path_optimizer/).
7+
This module provides avoidance functions for vehicles, pedestrians, and obstacles in the vicinity of the ego's path in combination with the [autoware_path_optimizer](https://autowarefoundation.github.io/autoware_universe/main/planning/autoware_path_optimizer/).
88
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-
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.
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.
1313
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.
@@ -90,7 +90,7 @@ As a result, as shown in the figure below, the polygons around the objects reduc
9090
<figcaption>Avoidance for the bus departure</figcaption>
9191
</figure>
9292

93-
<figure>
93+
<figure>
9494
<img src="./image/image-20230807-152835.png" width="800">
9595
<figcaption>Avoidance on curve </figcaption>
9696
</figure>

planning/behavior_path_planner/autoware_behavior_path_goal_planner_module/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ If the path given to goal_planner covers the goal, `fixed_goal_planner` smoothly
9595

9696
#### pull over on road lane
9797

98-
`rough_goal_planner` is triggered following the [behavior_path_planner scene module interface](https://autowarefoundation.github.io/autoware.universe/main/planning/behavior_path_planner/autoware_behavior_path_planner/docs/behavior_path_planner_manager_design/) namely through `isExecutionRequested` function and it returns true when following two conditions are met.
98+
`rough_goal_planner` is triggered following the [behavior_path_planner scene module interface](https://autowarefoundation.github.io/autoware_universe/main/planning/behavior_path_planner/autoware_behavior_path_planner/docs/behavior_path_planner_manager_design/) namely through `isExecutionRequested` function and it returns true when following two conditions are met.
9999

100100
- The distance between the goal and ego get shorter than $\max$(`pull_over_minimum_request_length`, stop distance with decel and jerk constraints).
101101
- Route is set with `allow_goal_modification=true` or is on a `road_shoulder` type lane.
@@ -205,7 +205,7 @@ Although the two threads are running periodically, the primary background proces
205205
- _arc forward_, _arc backward_ path planning
206206
- _bezier_ based path planning
207207

208-
depending on the situation and configuration. If `use_bus_stop_area` is true and the goal is on a BusStopArea regulatory element and the estimated pull over angle(the difference of pose between the shift start and shift end) is larger than `bezier_parking.pull_over_angle_threshold`, [_bezier_ based path planner](https://autowarefoundation.github.io/autoware.universe/main/planning/sampling_based_planner/autoware_bezier_sampler/) works to generate path candidates. Otherwise [_shift_ based path planner](https://autowarefoundation.github.io/autoware.universe/main/planning/behavior_path_planner/autoware_behavior_path_planner_common/docs/behavior_path_planner_path_generation_design/) works. _bezier_ based path planner tends to generate more natural paths on a curved lane than _shift_ based path planner, so it is used if the shift requires a certain amount of pose rotation.
208+
depending on the situation and configuration. If `use_bus_stop_area` is true and the goal is on a BusStopArea regulatory element and the estimated pull over angle(the difference of pose between the shift start and shift end) is larger than `bezier_parking.pull_over_angle_threshold`, [_bezier_ based path planner](https://autowarefoundation.github.io/autoware_universe/main/planning/sampling_based_planner/autoware_bezier_sampler/) works to generate path candidates. Otherwise [_shift_ based path planner](https://autowarefoundation.github.io/autoware_universe/main/planning/behavior_path_planner/autoware_behavior_path_planner_common/docs/behavior_path_planner_path_generation_design/) works. _bezier_ based path planner tends to generate more natural paths on a curved lane than _shift_ based path planner, so it is used if the shift requires a certain amount of pose rotation.
209209

210210
The overall flow is as follows.
211211

@@ -223,7 +223,7 @@ the main thread inserts a stop pose either at `closest_start_pose` which is the
223223

224224
Once the main thread finally selected the best pull over path, goal_planner transits to `DECIDED` state and it sets `SAFE` as the RTC status(NOTE: this `SAFE` means that "a safe pull over path has been finally selected".)
225225

226-
If there are no path candidates or the selected path is not SAFE and thus `the LaneParkingThread` causes ego to get stuck, the `FreespaceParkingThread` is triggered by the stuck detection and it starts generating path candidates using [freespace parking algorithms](https://autowarefoundation.github.io/autoware.universe/main/planning/autoware_freespace_planning_algorithms/). If a valid freespace path is found and ego is still stuck, the freespace path is used instead. If the selected lane parking pull over path becomes collision-free again in case the blocking parked objects moved, and the path is continuous from current freespace path, lane parking pull over path is selected again.
226+
If there are no path candidates or the selected path is not SAFE and thus `the LaneParkingThread` causes ego to get stuck, the `FreespaceParkingThread` is triggered by the stuck detection and it starts generating path candidates using [freespace parking algorithms](https://autowarefoundation.github.io/autoware_universe/main/planning/autoware_freespace_planning_algorithms/). If a valid freespace path is found and ego is still stuck, the freespace path is used instead. If the selected lane parking pull over path becomes collision-free again in case the blocking parked objects moved, and the path is continuous from current freespace path, lane parking pull over path is selected again.
227227

228228
| Name | Unit | Type | Description | Default value |
229229
| :------------------------------------ | :----- | :----- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------- |
@@ -241,7 +241,7 @@ If there are no path candidates or the selected path is not SAFE and thus `the L
241241
Pull over distance is calculated by the speed, lateral deviation, and the lateral jerk. The lateral jerk is searched for among the predetermined minimum and maximum values.
242242

243243
1. Apply uniform offset to centerline of shoulder lane for ensuring margin
244-
2. The interval of shift start and end is shifted by the [_shift_ based path planner](https://autowarefoundation.github.io/autoware.universe/main/planning/behavior_path_planner/autoware_behavior_path_planner_common/docs/behavior_path_planner_path_generation_design/)
244+
2. The interval of shift start and end is shifted by the [_shift_ based path planner](https://autowarefoundation.github.io/autoware_universe/main/planning/behavior_path_planner/autoware_behavior_path_planner_common/docs/behavior_path_planner_path_generation_design/)
245245
3. Combine this path with center line of road lane and the remaining shoulder lane centerline
246246

247247
![shift_parking](./images/shift_parking.drawio.svg)

planning/behavior_path_planner/autoware_behavior_path_lane_change_module/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -475,9 +475,9 @@ Additionally if terminal path feature is enabled and path is computed, stop poin
475475

476476
Generating path using Frenet planner applies only when ego is near terminal start
477477

478-
If the ego vehicle is far from the terminal, the lane change module defaults to using the [path shifter](https://autowarefoundation.github.io/autoware.universe/main/planning/behavior_path_planner/autoware_behavior_path_planner_common/docs/behavior_path_planner_path_generation_design/). This ensures that the lane change is completed while the target lane remains a neighbor of the current lane. However, this approach may result in high curvature paths near the terminal, potentially causing long vehicles to deviate from the lane.
478+
If the ego vehicle is far from the terminal, the lane change module defaults to using the [path shifter](https://autowarefoundation.github.io/autoware_universe/main/planning/behavior_path_planner/autoware_behavior_path_planner_common/docs/behavior_path_planner_path_generation_design/). This ensures that the lane change is completed while the target lane remains a neighbor of the current lane. However, this approach may result in high curvature paths near the terminal, potentially causing long vehicles to deviate from the lane.
479479

480-
To address this, the lane change module provides an option to choose between the path shifter and the [Frenet planner](https://autowarefoundation.github.io/autoware.universe/main/planning/sampling_based_planner/autoware_frenet_planner/). The Frenet planner allows for some flexibility in the lane change endpoint, extending the lane changing end point slightly beyond the current lane's neighbors.
480+
To address this, the lane change module provides an option to choose between the path shifter and the [Frenet planner](https://autowarefoundation.github.io/autoware_universe/main/planning/sampling_based_planner/autoware_frenet_planner/). The Frenet planner allows for some flexibility in the lane change endpoint, extending the lane changing end point slightly beyond the current lane's neighbors.
481481

482482
The following table provides comparisons between the planners
483483

@@ -1005,7 +1005,7 @@ Furthermore, if the path has become unsafe, there are three possible outcomes fo
10051005

10061006
1. **CANCEL**: The approved path has become unsafe while ego is still in prepare phase. Lane change path is canceled, and the ego vehicle resumes its previous maneuver.
10071007
2. **ABORT**: The approved path has become unsafe while ego is in lane changing phase. Lane change module generates a return path to bring the ego vehicle back to its current lane.
1008-
3. **CRUISE** or **STOP**: If aborting is not feasible, the ego vehicle continues with the lane change. [Another module](https://autowarefoundation.github.io/autoware.universe/main/planning/autoware_obstacle_cruise_planner/) should decide whether the ego vehicle should cruise or stop in this scenario.
1008+
3. **CRUISE** or **STOP**: If aborting is not feasible, the ego vehicle continues with the lane change. [Another module](https://autowarefoundation.github.io/autoware_universe/main/planning/autoware_obstacle_cruise_planner/) should decide whether the ego vehicle should cruise or stop in this scenario.
10091009

10101010
**CANCEL** can be enabled by setting the `cancel.enable_on_prepare_phase` flag to `true`, and **ABORT** can be enabled by setting the `cancel.enable_on_lane_changing_phase` flag to true.
10111011

@@ -1425,7 +1425,7 @@ Available information
14251425

14261426
## Limitation
14271427

1428-
1. When a lane change is canceled, the lane change module returns `ModuleStatus::FAILURE`. As the module is removed from the approved module stack (see [Failure modules](https://autowarefoundation.github.io/autoware.universe/main/planning/behavior_path_planner/autoware_behavior_path_planner/docs/behavior_path_planner_manager_design/#failure-modules)), a new instance of the lane change module is initiated. Due to this, any information stored prior to the reset is lost. For example, the `lane_change_prepare_duration` in the `TransientData` is reset to its maximum value.
1429-
2. The lane change module has no knowledge of any velocity modifications introduced to the path after it is approved. This is because other modules may add deceleration points after subscribing to the behavior path planner output, and the final velocity is managed by the [velocity smoother](https://autowarefoundation.github.io/autoware.universe/main/planning/autoware_velocity_smoother/). Since this limitation affects **CANCEL**, the lane change module mitigates it by [sampling accelerations along the approved lane change path](#checking-approved-path-safety). These sampled accelerations are used during safety checks to estimate the velocity that might occur if the ego vehicle decelerates.
1428+
1. When a lane change is canceled, the lane change module returns `ModuleStatus::FAILURE`. As the module is removed from the approved module stack (see [Failure modules](https://autowarefoundation.github.io/autoware_universe/main/planning/behavior_path_planner/autoware_behavior_path_planner/docs/behavior_path_planner_manager_design/#failure-modules)), a new instance of the lane change module is initiated. Due to this, any information stored prior to the reset is lost. For example, the `lane_change_prepare_duration` in the `TransientData` is reset to its maximum value.
1429+
2. The lane change module has no knowledge of any velocity modifications introduced to the path after it is approved. This is because other modules may add deceleration points after subscribing to the behavior path planner output, and the final velocity is managed by the [velocity smoother](https://autowarefoundation.github.io/autoware_universe/main/planning/autoware_velocity_smoother/). Since this limitation affects **CANCEL**, the lane change module mitigates it by [sampling accelerations along the approved lane change path](#checking-approved-path-safety). These sampled accelerations are used during safety checks to estimate the velocity that might occur if the ego vehicle decelerates.
14301430
3. Ideally, the abort path should account for whether its execution would affect trailing vehicles in the current lane. However, the lane change module does not evaluate such interactions or assess whether the abort path is safe. As a result, **the abort path is not guaranteed to be safe**. To minimize the risk of unsafe situations, the abort maneuver is only permitted if the ego vehicle has not yet diverged from the current lane.
14311431
4. Due to limited resources, the abort path logic is not fully optimized. The generated path may overshoot, causing the return trajectory to slightly shift toward the opposite lane. This can be dangerous, especially if the opposite lane has traffic moving in the opposite direction. Furthermore, the logic does not account for different vehicle types, which can lead to varying effects. For instance, the behavior might differ significantly between a bus and a small passenger car.

planning/behavior_velocity_planner/autoware_behavior_velocity_crosswalk_module/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,7 @@ The label of each plot is `<crosswalk module id>-<pedestrian uuid>`.
349349
### Behavior
350350

351351
- Q. The ego stopped around the crosswalk even though there were no crosswalk user objects.
352-
- A. See [Stuck Vehicle Detection](https://autowarefoundation.github.io/autoware.universe/pr-5583/planning/autoware_behavior_velocity_crosswalk_module/#stuck-vehicle-detection).
352+
- A. See [Stuck Vehicle Detection](https://autowarefoundation.github.io/autoware_universe/pr-5583/planning/autoware_behavior_velocity_crosswalk_module/#stuck-vehicle-detection).
353353
- Q. The crosswalk virtual wall suddenly appeared resulting in the sudden stop.
354354
- A. There may be a crosswalk user started moving when the ego was close to the crosswalk.
355355
- Q. The crosswalk module decides to stop even when the pedestrian traffic light is red.
@@ -360,9 +360,9 @@ The label of each plot is `<crosswalk module id>-<pedestrian uuid>`.
360360
### Parameter Tuning
361361

362362
- Q. The ego's yield behavior is too conservative.
363-
- A. Tune `ego_pass_later_margin` described in [Yield Decision](https://autowarefoundation.github.io/autoware.universe/pr-5583/planning/autoware_behavior_velocity_crosswalk_module/#stuck-vehicle-detection)
363+
- A. Tune `ego_pass_later_margin` described in [Yield Decision](https://autowarefoundation.github.io/autoware_universe/pr-5583/planning/autoware_behavior_velocity_crosswalk_module/#stuck-vehicle-detection)
364364
- Q. The ego's yield behavior is too aggressive.
365-
- A. Tune `ego_pass_later_margin` described in [Yield Decision](https://autowarefoundation.github.io/autoware.universe/pr-5583/planning/autoware_behavior_velocity_crosswalk_module/#stuck-vehicle-detection)
365+
- A. Tune `ego_pass_later_margin` described in [Yield Decision](https://autowarefoundation.github.io/autoware_universe/pr-5583/planning/autoware_behavior_velocity_crosswalk_module/#stuck-vehicle-detection)
366366

367367
## References/External links
368368

planning/behavior_velocity_planner/autoware_behavior_velocity_intersection_module/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -508,7 +508,7 @@ If you want to care the occlusion nearby ego more cautiously, set `occlusion.occ
508508

509509
#### occupancy grid map tuning
510510

511-
Refer to the document of [autoware_probabilistic_occupancy_grid_map](https://autowarefoundation.github.io/autoware.universe/main/perception/autoware_probabilistic_occupancy_grid_map/) for details. If occlusion tends to be detected at apparently free space, increase `occlusion.free_space_max` to ignore them.
511+
Refer to the document of [autoware_probabilistic_occupancy_grid_map](https://autowarefoundation.github.io/autoware_universe/main/perception/autoware_probabilistic_occupancy_grid_map/) for details. If occlusion tends to be detected at apparently free space, increase `occlusion.free_space_max` to ignore them.
512512

513513
#### in simple_planning_simulator
514514

0 commit comments

Comments
 (0)