Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 970fdae

Browse files
committedJan 27, 2024
chore(radar_tracks_msgs_converter): fix README
Signed-off-by: scepter914 <scepter914@gmail.com>
1 parent 57cf88d commit 970fdae

File tree

1 file changed

+52
-25
lines changed
  • perception/radar_tracks_msgs_converter

1 file changed

+52
-25
lines changed
 

‎perception/radar_tracks_msgs_converter/README.md

+52-25
Original file line numberDiff line numberDiff line change
@@ -6,32 +6,15 @@ This package converts from [radar_msgs/msg/RadarTracks](https://github.com/ros-p
66
- n: The number of radar objects
77

88
## Design
9+
### Background
910

10-
### Input / Output
11+
Autoware uses [radar_msgs/msg/RadarTracks.msg](https://github.com/ros-perception/radar_msgs/blob/ros2/msg/RadarTracks.msg) as radar objects input data.
12+
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`.
13+
In addition, because many detection module have an assumption on base_link frame, `radar_tracks_msgs_converter` provide the functions of transform frame_id.
1114

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.
15+
### Note
1816

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
33-
34-
This package convert the label from `radar_msgs/msg/RadarTrack.msg` to Autoware label.
17+
`Radar_tracks_msgs_converter` converts the label from `radar_msgs/msg/RadarTrack.msg` to Autoware label.
3518
Label id is defined as below.
3619

3720
| | RadarTrack | Autoware |
@@ -45,6 +28,50 @@ Label id is defined as below.
4528
| BICYCLE | 32006 | 6 |
4629
| PEDESTRIAN | 32007 | 7 |
4730

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.
31+
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).
32+
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)
33+
34+
## Interface
35+
### Input
36+
37+
- `~/input/radar_objects` (radar_msgs/msg/RadarTracks.msg): Input radar topic
38+
- `~/input/odometry` (nav_msgs/msg/Odometry.msg): Ego vehicle odometry topic
39+
40+
### Output
41+
42+
- `~/output/radar_detected_objects` (autoware_auto_perception_msgs/msg/DetectedObject.idl): The topic converted to Autoware message.
43+
- This is used for radar sensor fusion detection and radar detection.
44+
- `~/output/radar_tracked_objects` (autoware_auto_perception_msgs/msg/TrackedObject.idl): The topic converted to Autoware message.
45+
- This is used for tracking layer sensor fusion.
46+
47+
### Parameters
48+
49+
- `update_rate_hz` (double) [hz]
50+
- Default parameter is 20.0
51+
52+
This parameter is update rate for the `onTimer` function.
53+
This parameter should be same as the frame rate of input topics.
54+
55+
- `new_frame_id` (string)
56+
- Default parameter is "base_link"
57+
58+
This parameter is the header frame_id of the output topic.
59+
60+
- `use_twist_compensation` (bool)
61+
- Default parameter is "true"
62+
63+
This parameter is the flag to use the compensation to linear of ego vehicle's twist.
64+
If the parameter is true, then the twist of the output objects' topic is compensated by the ego vehicle linear motion.
65+
66+
- `use_twist_yaw_compensation` (bool)
67+
- Default parameter is "false"
68+
69+
This parameter is the flag to use the compensation to yaw rotation of ego vehicle's twist.
70+
71+
If the parameter is true, then the ego motion compensation will also consider yaw motion of the ego vehicle.
72+
73+
- `static_object_speed_threshold` (float) [m/s]
74+
- Default parameter is 1.0
4975

50-
- [Autoware objects label](https://gitlab.com/autowarefoundation/autoware.auto/autoware_auto_msgs/-/blob/master/autoware_auto_perception_msgs/msg/ObjectClassification.idl)
76+
This parameter is the threshold to determine the flag `is_stationary`.
77+
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)
Please sign in to comment.