Skip to content

Commit be95277

Browse files
committed
chore: update readme
1 parent 725a49e commit be95277

File tree

1 file changed

+23
-20
lines changed

1 file changed

+23
-20
lines changed

perception/multi_object_tracker/README.md

+23-20
Original file line numberDiff line numberDiff line change
@@ -46,27 +46,34 @@ Example:
4646

4747
### Input
4848

49-
| Name | Type | Description |
50-
| --------- | ----------------------------------------------------- | ----------- |
51-
| `~/input` | `autoware_auto_perception_msgs::msg::DetectedObjects` | obstacles |
49+
Multiple inputs are pre-defined in the input channel parameters (described below) and the inputs can be configured
50+
51+
| Name | Type | Description |
52+
| ------------------------- | -------------------------- | ---------------------- |
53+
| `selected_input_channels` | `std::vector<std::string>` | array of channel names |
54+
55+
- default value: `selected_input_channels:="['detected_objects']"`, merged DetectedObject message
56+
- multi-input example: `selected_input_channels:="['lidar_centerpoint','camera_lidar_fusion','detection_by_tracker','radar_far']"`
5257

5358
### Output
5459

55-
| Name | Type | Description |
56-
| ---------- | ---------------------------------------------------- | ------------------ |
57-
| `~/output` | `autoware_auto_perception_msgs::msg::TrackedObjects` | modified obstacles |
60+
| Name | Type | Description |
61+
| ---------- | ---------------------------------------------------- | --------------- |
62+
| `~/output` | `autoware_auto_perception_msgs::msg::TrackedObjects` | tracked objects |
5863

5964
## Parameters
6065

61-
<!-- Write parameters of this package.
66+
### Input Channel parameters
6267

63-
Example:
64-
### Node Parameters
68+
Available input channels are defined in [input_channels.param.yaml](config/input_channels.param.yaml).
6569

66-
| Name | Type | Description |
67-
| ---------------------- | ---- | ------------------------------- |
68-
| `output_debug_markers` | bool | whether to output debug markers |
69-
-->
70+
| Name | Type | Description |
71+
| --------------------------------- | ----------------------------------------------------- | ------------------------------------- |
72+
| `<channel>` | | the name of channel |
73+
| `<channel>.topic` | `autoware_auto_perception_msgs::msg::DetectedObjects` | detected objects |
74+
| `<channel>.can_spawn_new_tracker` | `bool` | a switch allow to spawn a new tracker |
75+
| `<channel>.optional.name` | `std::string` | channel name for analysis |
76+
| `<channel>.optional.short_name` | `std::string` | short name for visualization |
7077

7178
### Core Parameters
7279

@@ -80,6 +87,9 @@ Node parameters are defined in [multi_object_tracker.param.yaml](config/multi_ob
8087
| `world_frame_id` | double | object kinematics definition frame |
8188
| `enable_delay_compensation` | bool | if True, tracker use timers to schedule publishers and use prediction step to extrapolate object state at desired timestamp |
8289
| `publish_rate` | double | Timer frequency to output with delay compensation |
90+
| `publish_processing_time` | bool | enable to publish debug message of process time information |
91+
| `publish_tentative_objects` | bool | enable to publish tentative tracked objects, which have lower confidence |
92+
| `publish_debug_markers` | bool | enable to publish debug markers, which indicates association of multi-inputs, existence probability of each detection |
8393

8494
#### Association parameters
8595

@@ -93,13 +103,6 @@ Node parameters are defined in [multi_object_tracker.param.yaml](config/multi_ob
93103

94104
## Assumptions / Known limits
95105

96-
<!-- Write assumptions and limitations of your implementation.
97-
98-
Example:
99-
This algorithm assumes obstacles are not moving, so if they rapidly move after the vehicle started to avoid them, it might collide with them.
100-
Also, this algorithm doesn't care about blind spots. In general, since too close obstacles aren't visible due to the sensing performance limit, please take enough margin to obstacles.
101-
-->
102-
103106
See the [model explanations](models.md).
104107

105108
## (Optional) Error detection and handling

0 commit comments

Comments
 (0)