]> rtime.felk.cvut.cz Git - hubacji1/path-to-traj.git/commitdiff
Improve docstring
authorJiri Vlasak <jiri.vlasak.2@cvut.cz>
Wed, 8 Mar 2023 09:42:10 +0000 (10:42 +0100)
committerJiri Vlasak <jiri.vlasak.2@cvut.cz>
Wed, 8 Mar 2023 23:41:40 +0000 (00:41 +0100)
path-to-traj.py

index 6bea9c0f30315b2614498e4be0158eb9e5098f25..18f65229ee6dd0b252fa1e6673a414d9536ab3ed 100755 (executable)
@@ -1,5 +1,13 @@
 #!/usr/bin/env python3
-"""Translate equidistant path to equitemporal (isochronic) trajectory."""
+"""Translate equidistant path to equitemporal (isochronic) trajectory.
+
+Path does not need to be equidistant, in fact. Typically, the last point
+of the path segment is closer due to interpolation.
+
+It is expected that the point of the path has five values: x, y,
+heading, speed, and type, where type is +1 for left turn, -1 for right
+turn, and 0 for straight segment.
+"""
 from math import sin, atan, cos, tan, pi, acos
 import json