Skip to content

Commit

Permalink
docs: More documentation on PostureTask.target_q
Browse files Browse the repository at this point in the history
  • Loading branch information
stephane-caron committed Dec 16, 2024
1 parent efd94fb commit b26d952
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions pink/tasks/posture_task.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,13 @@ class PostureTask(Task):
are not affected by this task.
Attributes:
target_q: Target vector in the configuration space.
target_q: Target vector in the configuration space. If the model has a
floating base, then this vector should include floating-base
coordinates (although they have no effect on the posture task).
A posture task is typically used for regularization as it has a steady
rank. For instance, when Upkie's legs are stretched and the Jacobian of its
contact frames become singular, the posture task will drive the knees
contact frames becomes singular, the posture task will drive the knees
toward a preferred orientation.
"""

Expand Down Expand Up @@ -62,7 +64,10 @@ def set_target(self, target_q: np.ndarray) -> None:
"""Set target posture.
Args:
target_q: Target vector in the configuration space.
target_q: Target vector in the configuration space. If the model
has a floating base, then this vector should include
floating-base coordinates (although they have no effect on the
posture task).
"""
self.target_q = target_q.copy()

Expand Down

0 comments on commit b26d952

Please sign in to comment.