You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: common/autoware_trajectory/README.md
+16-10Lines changed: 16 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -134,16 +134,22 @@ Several `Trajectory<T>` are defined in the following inheritance hierarchy accor
134
134
135
135
Each derived class in the diagram inherits the methods of all of its descending subclasses. For example, all of the classes have the methods like `length()`, `curvature()` in common.
| <ul><li>`Trajectory<Point>`</li></ul> |`base_arange(const double step)`| return vector of `s` values starting from `start`, with the interval of `step`, including `end`. Thus the return value has at least the size of 2. ||
144
-
||`length()`| return the total `arc length` of the trajectory. |<br>[View in Drawio]({{ drawio("/common/autoware_trajectory/images/nomenclature/curve.drawio.svg") }})<br>`length()` is $5.0$ because it computes the sum of the length of dotted lines. |
145
-
||`azimuth(const double s)`| return the tangent angle at given `s` coordinate using `std::atan2`. |<br>[View in Drawio]({{ drawio("/common/autoware_trajectory/images/overview/trajectory.drawio.svg") }}) |
146
-
||`curvature(const double s)`| return the `curvature` at given `s` coordinate. | See above |
| <ul><li>`Trajectory<Point>`</li></ul> |`base_arange(const double step)`| return vector of `s` values starting from `start`, with the interval of `step`, including `end`. Thus the return value has at least the size of 2. ||
144
+
||`length()`| return the total `arc length` of the trajectory. |<br>[View in Drawio]({{ drawio("/common/autoware_trajectory/images/nomenclature/curve.drawio.svg") }})<br>`length()` is $5.0$ because it computes the sum of the length of dotted lines. |
145
+
||`azimuth(const double s)`| return the tangent angle at given `s` coordinate using `std::atan2`. |<br>[View in Drawio]({{ drawio("/common/autoware_trajectory/images/overview/trajectory.drawio.svg") }}) |
146
+
||`curvature(const double s)`| return the signed `curvature` at given `s` coordinate following $\sqrt{\dot{x}^2 + \dot{y}^2}^3 / (\dot{x}\ddot{y} - \dot{y}\ddot{x})$. | See above |
147
+
||`elevation(const double s)`| return the elevation angle at given `s` coordinate. ||
148
+
||`get_underlying_base()`| return the vector of `s` values of current `underlying` points. ||
149
+
|`<autoware/trajectory/pose.hpp>`<br><ul><li>`Trajectory<geometry_msgs::msg::Pose>::Builder`</li></ul> |`Builder()`| set default interpolator setting in addition to that of `Trajectory<Point>::Builder` as follows.<br><ul><li>`orientation`: SphericalLinear</li></ul> ||
150
+
||`set_orientation_interpolator<InterpolatorType>()`| set custom interpolator for `orientation`. ||
151
+
| <ul><li>`Trajectory<Pose>`</li></ul> | derives all of the above methods of `Trajectory<Point>`|||
152
+
||`align_orientation_with_trajectory_direction()`| update the underlying points so that their orientations match the `azimuth()` of interpolated `curve`. This is useful when the user gave only the position of `Pose` and created `Trajectory` object. |<br>[View in Drawio]({{ drawio("/common/autoware_trajectory/images/utils/align_orientation_with_trajectory_direction.drawio.svg") }}) |
0 commit comments