Skip to content

Commit 3e6c3a5

Browse files
authored
docs(surround_obstacle_checker): add descriptions of some parameters (#5977)
Signed-off-by: tomoya.kimura <tomoya.kimura@tier4.jp>
1 parent c625f3c commit 3e6c3a5

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

planning/surround_obstacle_checker/README.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -103,16 +103,17 @@ As mentioned in stop condition section, it prevents chattering by changing thres
103103

104104
{{ json_to_markdown("planning/surround_obstacle_checker/schema/surround_obstacle_checker.schema.json") }}
105105

106-
| Name | Type | Description | Default value |
107-
| :-------------------------------- | :------- | :------------------------------------------------------------------------------------- | :------------ |
108-
| `use_pointcloud` | `bool` | Use pointcloud as obstacle check | `true` |
109-
| `use_dynamic_object` | `bool` | Use dynamic object as obstacle check | `true` |
110-
| `surround_check_distance` | `double` | If objects exist in this distance, transit to "exist-surrounding-obstacle" status [m] | 0.5 |
111-
| `surround_check_recover_distance` | `double` | If no object exists in this distance, transit to "non-surrounding-obstacle" status [m] | 0.8 |
112-
| `state_clear_time` | `double` | Threshold to clear stop state [s] | 2.0 |
113-
| `stop_state_ego_speed` | `double` | Threshold to check ego vehicle stopped [m/s] | 0.1 |
114-
| `stop_state_entry_duration_time` | `double` | Threshold to check ego vehicle stopped [s] | 0.1 |
115-
| `publish_debug_footprints` | `bool` | Publish vehicle footprint with/without offsets | `true` |
106+
| Name | Type | Description | Default value |
107+
| :----------------------------------- | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------- |
108+
| `enable_check` | `bool` | Indicates whether each object is considered in the obstacle check target. | `true` for objects; `false` for point clouds |
109+
| `surround_check_front_distance` | `bool` | If there are objects or point clouds within this distance in front, transition to the "exist-surrounding-obstacle" status [m]. | 0.5 |
110+
| `surround_check_side_distance` | `double` | If there are objects or point clouds within this side distance, transition to the "exist-surrounding-obstacle" status [m]. | 0.5 |
111+
| `surround_check_back_distance` | `double` | If there are objects or point clouds within this back distance, transition to the "exist-surrounding-obstacle" status [m]. | 0.5 |
112+
| `surround_check_hysteresis_distance` | `double` | If no object exists within `surround_check_xxx_distance` plus this additional distance, transition to the "non-surrounding-obstacle" status [m]. | 0.3 |
113+
| `state_clear_time` | `double` | Threshold to clear stop state [s] | 2.0 |
114+
| `stop_state_ego_speed` | `double` | Threshold to check ego vehicle stopped [m/s] | 0.1 |
115+
| `stop_state_entry_duration_time` | `double` | Threshold to check ego vehicle stopped [s] | 0.1 |
116+
| `publish_debug_footprints` | `bool` | Publish vehicle footprint with/without offsets | `true` |
116117

117118
## Assumptions / Known limits
118119

0 commit comments

Comments
 (0)