Skip to content

Commit 18a599e

Browse files
chore(radar_tracks_msgs_converter): fix README (#6226)
* chore(radar_tracks_msgs_converter): fix README Signed-off-by: scepter914 <scepter914@gmail.com> * 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>
1 parent 92434b5 commit 18a599e

File tree

1 file changed

+56
-24
lines changed
  • perception/radar_tracks_msgs_converter

1 file changed

+56
-24
lines changed

perception/radar_tracks_msgs_converter/README.md

+56-24
Original file line numberDiff line numberDiff line change
@@ -7,31 +7,15 @@ This package converts from [radar_msgs/msg/RadarTracks](https://github.com/ros-p
77

88
## Design
99

10-
### Input / Output
10+
### Background
1111

12-
- Input
13-
- `~/input/radar_objects` (radar_msgs/msg/RadarTracks.msg): Input radar topic
14-
- `~/input/odometry` (nav_msgs/msg/Odometry.msg): Ego vehicle odometry topic
15-
- Output
16-
- `~/output/radar_detected_objects` (autoware_auto_perception_msgs/msg/DetectedObject.idl): The topic converted to Autoware's message. This is used for radar sensor fusion detection and radar detection.
17-
- `~/output/radar_tracked_objects` (autoware_auto_perception_msgs/msg/TrackedObject.idl): The topic converted to Autoware's message. This is used for tracking layer sensor fusion.
12+
Autoware uses [radar_msgs/msg/RadarTracks.msg](https://github.com/ros-perception/radar_msgs/blob/ros2/msg/RadarTracks.msg) as radar objects input data.
13+
To use radar objects data for Autoware perception module easily, `radar_tracks_msgs_converter` converts message type from `radar_msgs/msg/RadarTracks.msg` to `autoware_auto_perception_msgs/msg/DetectedObject`.
14+
In addition, because many detection module have an assumption on base_link frame, `radar_tracks_msgs_converter` provide the functions of transform frame_id.
1815

19-
### Parameters
20-
21-
- `update_rate_hz` (double): The update rate [hz].
22-
- Default parameter is 20.0
23-
- `new_frame_id` (string): The header frame of the output topic.
24-
- Default parameter is "base_link"
25-
- `use_twist_compensation` (bool): If the parameter is true, then the twist of the output objects' topic is compensated by ego vehicle motion.
26-
- Default parameter is "true"
27-
- `use_twist_yaw_compensation` (bool): If the parameter is true, then the ego motion compensation will also consider yaw motion of the ego vehicle.
28-
- Default parameter is "false"
29-
- `static_object_speed_threshold` (float): Specify the threshold for static object speed which determines the flag `is_stationary` [m/s].
30-
- Default parameter is 1.0
31-
32-
## Note
16+
### Note
3317

34-
This package convert the label from `radar_msgs/msg/RadarTrack.msg` to Autoware label.
18+
`Radar_tracks_msgs_converter` converts the label from `radar_msgs/msg/RadarTrack.msg` to Autoware label.
3519
Label id is defined as below.
3620

3721
| | RadarTrack | Autoware |
@@ -45,6 +29,54 @@ Label id is defined as below.
4529
| BICYCLE | 32006 | 6 |
4630
| PEDESTRIAN | 32007 | 7 |
4731

48-
- [radar_msgs/msg/RadarTrack.msg](https://github.com/ros-perception/radar_msgs/blob/ros2/msg/RadarTrack.msg): additional vendor-specific classifications are permitted starting from 32000.
32+
Additional vendor-specific classifications are permitted starting from 32000 in [radar_msgs/msg/RadarTrack.msg](https://github.com/ros-perception/radar_msgs/blob/ros2/msg/RadarTrack.msg).
33+
Autoware objects label is defined in [ObjectClassification.idl](https://gitlab.com/autowarefoundation/autoware.auto/autoware_auto_msgs/-/blob/master/autoware_auto_perception_msgs/msg/ObjectClassification.idl)
34+
35+
## Interface
36+
37+
### Input
38+
39+
- `~/input/radar_objects` (`radar_msgs/msg/RadarTracks.msg`)
40+
- Input radar topic
41+
- `~/input/odometry` (`nav_msgs/msg/Odometry.msg`)
42+
- Ego vehicle odometry topic
43+
44+
### Output
45+
46+
- `~/output/radar_detected_objects` (`autoware_auto_perception_msgs/msg/DetectedObject.idl`)
47+
- DetectedObject topic converted to Autoware message.
48+
- This is used for radar sensor fusion detection and radar detection.
49+
- `~/output/radar_tracked_objects` (`autoware_auto_perception_msgs/msg/TrackedObject.idl`)
50+
- TrackedObject topic converted to Autoware message.
51+
- This is used for tracking layer sensor fusion.
52+
53+
### Parameters
54+
55+
- `update_rate_hz` (double) [hz]
56+
- Default parameter is 20.0
57+
58+
This parameter is update rate for the `onTimer` function.
59+
This parameter should be same as the frame rate of input topics.
60+
61+
- `new_frame_id` (string)
62+
- Default parameter is "base_link"
63+
64+
This parameter is the header frame_id of the output topic.
65+
66+
- `use_twist_compensation` (bool)
67+
- Default parameter is "true"
68+
69+
This parameter is the flag to use the compensation to linear of ego vehicle's twist.
70+
If the parameter is true, then the twist of the output objects' topic is compensated by the ego vehicle linear motion.
71+
72+
- `use_twist_yaw_compensation` (bool)
73+
- Default parameter is "false"
74+
75+
This parameter is the flag to use the compensation to yaw rotation of ego vehicle's twist.
76+
If the parameter is true, then the ego motion compensation will also consider yaw motion of the ego vehicle.
77+
78+
- `static_object_speed_threshold` (float) [m/s]
79+
- Default parameter is 1.0
4980

50-
- [Autoware objects label](https://gitlab.com/autowarefoundation/autoware.auto/autoware_auto_msgs/-/blob/master/autoware_auto_perception_msgs/msg/ObjectClassification.idl)
81+
This parameter is the threshold to determine the flag `is_stationary`.
82+
If the velocity is lower than this parameter, the flag `is_stationary` of DetectedObject is set to `true` and dealt as a static object.

0 commit comments

Comments
 (0)