From 4572aee4f587d5ee5fbd4c9532df8289c83c6180 Mon Sep 17 00:00:00 2001 From: scepter914 Date: Wed, 31 Jan 2024 03:47:29 +0900 Subject: [PATCH 1/2] chore(object_velocity_splitter): fix README Signed-off-by: scepter914 --- perception/object_velocity_splitter/README.md | 27 ++++++++++--------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/perception/object_velocity_splitter/README.md b/perception/object_velocity_splitter/README.md index 9dcd535a5a10f..8443e4e6a7f42 100644 --- a/perception/object_velocity_splitter/README.md +++ b/perception/object_velocity_splitter/README.md @@ -3,21 +3,22 @@ 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). This package can split DetectedObjects into two messages by object's speed. -## Input +## Interface +### Input -| Name | Type | Description | -| ----------------- | ----------------------------------------------------- | -------------------- | -| `~/input/objects` | autoware_auto_perception_msgs/msg/DetectedObjects.msg | 3D detected objects. | +- `~/input/objects` (`autoware_auto_perception_msgs/msg/DetectedObjects.msg`) + - 3D detected objects -## Output +### Output -| Name | Type | Description | -| ----------------------------- | ----------------------------------------------------- | ----------------------- | -| `~/output/low_speed_objects` | autoware_auto_perception_msgs/msg/DetectedObjects.msg | Objects with low speed | -| `~/output/high_speed_objects` | autoware_auto_perception_msgs/msg/DetectedObjects.msg | Objects with high speed | +- `~/output/low_speed_objects` (`autoware_auto_perception_msgs/msg/DetectedObjects.msg`) + - Objects with low speed +- `~/output/high_speed_objects` (`autoware_auto_perception_msgs/msg/DetectedObjects.msg`) + - Objects with high speed -## Parameters +### Parameters -| Name | Type | Description | Default value | -| :------------------- | :----- | :-------------------------------------------------- | :------------ | -| `velocity_threshold` | double | Velocity threshold parameter to split objects [m/s] | 3.0 | +- `velocity_threshold` (double) [m/s] + - Default parameter is 3.0 + +This parameter is velocity threshold to split objects From 3198c5695fb85ba67db3c8c004921ac2035a8e94 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 1 Feb 2024 00:19:29 +0000 Subject: [PATCH 2/2] style(pre-commit): autofix --- perception/object_velocity_splitter/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/perception/object_velocity_splitter/README.md b/perception/object_velocity_splitter/README.md index 8443e4e6a7f42..57d2834f3f442 100644 --- a/perception/object_velocity_splitter/README.md +++ b/perception/object_velocity_splitter/README.md @@ -4,6 +4,7 @@ This package contains a object filter module for [autoware_auto_perception_msgs/ This package can split DetectedObjects into two messages by object's speed. ## Interface + ### Input - `~/input/objects` (`autoware_auto_perception_msgs/msg/DetectedObjects.msg`)