Skip to content

Commit 069fb5e

Browse files
scepter914pre-commit-ci[bot]HansRobo
authored
chore(object_velocity_splitter): fix README (#6259)
* chore(object_velocity_splitter): fix README Signed-off-by: scepter914 <scepter914@gmail.com> * style(pre-commit): autofix --------- Signed-off-by: scepter914 <scepter914@gmail.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Kotaro Yoshimoto <pythagora.yoshimoto@gmail.com>
1 parent a1df4a6 commit 069fb5e

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

perception/object_velocity_splitter/README.md

+15-13
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,23 @@
33
This package contains a object filter module for [autoware_auto_perception_msgs/msg/DetectedObject](https://gitlab.com/autowarefoundation/autoware.auto/autoware_auto_msgs/-/blob/master/autoware_auto_perception_msgs/msg/DetectedObject.idl).
44
This package can split DetectedObjects into two messages by object's speed.
55

6-
## Input
6+
## Interface
77

8-
| Name | Type | Description |
9-
| ----------------- | ----------------------------------------------------- | -------------------- |
10-
| `~/input/objects` | autoware_auto_perception_msgs/msg/DetectedObjects.msg | 3D detected objects. |
8+
### Input
119

12-
## Output
10+
- `~/input/objects` (`autoware_auto_perception_msgs/msg/DetectedObjects.msg`)
11+
- 3D detected objects
1312

14-
| Name | Type | Description |
15-
| ----------------------------- | ----------------------------------------------------- | ----------------------- |
16-
| `~/output/low_speed_objects` | autoware_auto_perception_msgs/msg/DetectedObjects.msg | Objects with low speed |
17-
| `~/output/high_speed_objects` | autoware_auto_perception_msgs/msg/DetectedObjects.msg | Objects with high speed |
13+
### Output
1814

19-
## Parameters
15+
- `~/output/low_speed_objects` (`autoware_auto_perception_msgs/msg/DetectedObjects.msg`)
16+
- Objects with low speed
17+
- `~/output/high_speed_objects` (`autoware_auto_perception_msgs/msg/DetectedObjects.msg`)
18+
- Objects with high speed
2019

21-
| Name | Type | Description | Default value |
22-
| :------------------- | :----- | :-------------------------------------------------- | :------------ |
23-
| `velocity_threshold` | double | Velocity threshold parameter to split objects [m/s] | 3.0 |
20+
### Parameters
21+
22+
- `velocity_threshold` (double) [m/s]
23+
- Default parameter is 3.0
24+
25+
This parameter is velocity threshold to split objects

0 commit comments

Comments
 (0)