Skip to content

Commit

Permalink
Document how alpha_z is computed
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderFabisch committed Jun 26, 2024
1 parent 35738f9 commit 2bc96df
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion movement_primitives/dmp/_canonical_system.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
def canonical_system_alpha(goal_z, goal_t, start_t, int_dt=0.001):
"""Compute parameter alpha of canonical system.
r"""Compute parameter alpha of canonical system.
The parameter alpha is computed such that a specific phase value goal_z
is reached at goal_t. The canonical system is defined according to [1]_,
even though we compute a different value for alpha.
Parameters
----------
Expand All @@ -25,6 +29,14 @@ def canonical_system_alpha(goal_z, goal_t, start_t, int_dt=0.001):
------
ValueError
If input values are invalid.
References
----------
.. [1] Ijspeert, A. J., Nakanishi, J., Hoffmann, H., Pastor, P., Schaal, S.
(2013). Dynamical Movement Primitives: Learning Attractor Models for
Motor Behaviors. Neural Computation 25 (2), 328-373. DOI:
10.1162/NECO_a_00393,
https://homes.cs.washington.edu/~todorov/courses/amath579/reading/DynamicPrimitives.pdf
"""
if goal_z <= 0.0:
raise ValueError("Final phase must be > 0!")
Expand Down

0 comments on commit 2bc96df

Please sign in to comment.