Planning Evaluator#
Purpose#
This package provides nodes that generate metrics to evaluate the quality of planning and control.
Inner-workings / Algorithms#
The evaluation node calculates metrics each time it receives a trajectory T(0)
.
Metrics are calculated using the following information:
- the trajectory
T(0)
itself. - the previous trajectory
T(-1)
. - the reference trajectory assumed to be used as the reference to plan
T(0)
. - the current ego pose.
- the set of objects in the environment.
These information are maintained by an instance of class MetricsCalculator
which is also responsible for calculating metrics.
Stat#
Each metric is calculated using a autoware::universe_utils::Accumulator
instance which contains
the minimum, maximum, and mean values calculated for the metric
as well as the number of values measured.
Metric calculation and adding more metrics#
All possible metrics are defined in the Metric
enumeration defined
include/planning_evaluator/metrics/metric.hpp
.
This file also defines conversions from/to string as well as human readable descriptions
to be used as header of the output file.
The MetricsCalculator
is responsible for calculating metric statistics
through calls to function:
Accumulator<double> MetricsCalculator::calculate(const Metric metric, const Trajectory & traj) const;
Adding a new metric M
requires the following steps:
metrics/metric.hpp
: addM
to theenum
, to the from/to string conversion maps, and to the description map.metrics_calculator.cpp
: addM
to theswitch/case
statement of thecalculate
function.- Add
M
to theselected_metrics
parameters.
Inputs / Outputs#
Inputs#
Name | Type | Description |
---|---|---|
~/input/trajectory |
autoware_planning_msgs::msg::Trajectory |
Main trajectory to evaluate |
~/input/reference_trajectory |
autoware_planning_msgs::msg::Trajectory |
Reference trajectory to use for deviation metrics |
~/input/objects |
autoware_perception_msgs::msg::PredictedObjects |
Obstacles |
Outputs#
Each metric is published on a topic named after the metric name.
Name | Type | Description |
---|---|---|
~/metrics |
tier4_metric_msgs::msg::MetricArray |
MetricArray with many metrics of tier4_metric_msgs::msg::Metric |
If output_metrics = true
, the evaluation node writes the statics of the metrics measured during its lifetime
to <ros2_logging_directory>/autoware_metrics/<node_name>-<time_stamp>.json
when shut down.
Parameters#
Name | Type | Description | Default | Range |
---|---|---|---|---|
output_metrics | boolean | If true, the evaluation node writes the metrics' statics to <ros2_logging_directory>/autoware_metrics/<node_name>-<time_stamp>.json when the node shut down, |
false | N/A |
ego_frame | string | reference frame of ego | base_link | N/A |
selected_metrics | array | metrics to collect/record | ['curvature', 'point_interval', 'relative_angle', 'length', 'duration', 'velocity', 'acceleration', 'jerk', 'lateral_deviation', 'yaw_deviation', 'velocity_deviation', 'lateral_trajectory_displacement', 'stability', 'stability_frechet', 'obstacle_distance', 'obstacle_ttc', 'modified_goal_longitudinal_deviation', 'modified_goal_lateral_deviation', 'modified_goal_yaw_deviation'] | N/A |
trajectory.min_point_dist_m | float | minimum distance between two successive points to use for angle calculation | 0.1 | N/A |
lookahead.max_dist_m | float | maximum distance from ego along the trajectory to use for calculation | 5.0 | N/A |
lookahead.max_time_s | float | maximum time ahead of ego along the trajectory to use for calculation | 3.0 | N/A |
obstacle.dist_thr_m | float | distance between ego and the obstacle below which a collision is considered | 1.0 | N/A |
Assumptions / Known limits#
There is a strong assumption that when receiving a trajectory T(0)
,
it has been generated using the last received reference trajectory and objects.
This can be wrong if a new reference trajectory or objects are published while T(0)
is being calculated.
Precision is currently limited by the resolution of the trajectories. It is possible to interpolate the trajectory and reference trajectory to increase precision but would make computation significantly more expensive.
Future extensions / Unimplemented parts#
- Use
Route
orPath
messages as reference trajectory. - RSS metrics (done in another node https://tier4.atlassian.net/browse/AJD-263).
- Add option to publish the
min
andmax
metric values. For now only themean
value is published. motion_evaluator_node
.- Node which constructs a trajectory over time from the real motion of ego.
- Only a proof of concept is currently implemented.