chore: docs

Signed-off-by: badai-nguyen <dai.nguyen@tier4.jp>
autowarefoundation · Dec 24, 2024 · a830f41 · a830f41
1 parent 9999d28
commit a830f41
Showing 3 changed files with 25 additions and 2 deletions.
diff --git a/perception/autoware_traffic_light_signals_merger/README.md b/perception/autoware_traffic_light_signals_merger/README.md
@@ -0,0 +1,23 @@
+# The `autoware_traffic_light_signal_merger` Package
+
+## Overview
+
+`autoware_traffic_light_signal_merger` receives the Traffic Light (TL) classification result from Car/Pedestrian classifiers and expected ROIs to merge into single classification result. The expect ROIs TL without classification result will be filled as Unknown.
+
+## Input topics
+
+| Name                       | Type                                           | Description                   |
+| -------------------------- | ---------------------------------------------- | ----------------------------- |
+| `input/car_signals`        | tier4_perception_msgs::msg::TrafficLightArray  | Car TLs classification        |
+| `input/pedestrian_signals` | tier4_perception_msgs::msg::TrafficLightArray  | Pedestrian TLs classification |
+| `input/expect_rois`        | autoware_perception_msgs::TrafficLightRoiArray | expected TL ROIs              |
+
+## Output topics
+
+| Name                           | Type                                          | Description                           |
+| ------------------------------ | --------------------------------------------- | ------------------------------------- |
+| `output/traffic_light_signals` | tier4_perception_msgs::msg::TrafficLightArray | Car and Pedestrian TLs classification |
+
+## Node parameters
+
+N/A
diff --git a/perception/autoware_traffic_light_signals_merger/src/traffic_light_signals_merger_node.cpp b/perception/autoware_traffic_light_signals_merger/src/traffic_light_signals_merger_node.cpp
@@ -1,4 +1,4 @@
-// Copyright 2023 TIER IV, Inc.
+// Copyright 2024 TIER IV, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/perception/autoware_traffic_light_signals_merger/src/traffic_light_signals_merger_node.hpp b/perception/autoware_traffic_light_signals_merger/src/traffic_light_signals_merger_node.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 TIER IV, Inc.
+// Copyright 2024 TIER IV, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.