Skip to content

Commit d2f63fc

Browse files
committed
update doco for jacob method
now returns the transpose BREAKING CHANGE
1 parent a747f78 commit d2f63fc

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

‎spatialmath/pose3d.py‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -815,33 +815,33 @@ def Ad(self):
815815
:seealso: SE3.jacob, Twist.ad, :func:`~spatialmath.base.tr2jac`
816816
:SymPy: supported
817817
"""
818-
return base.adjoint(self.A)
818+
return base.tr2adjoint(self.A)
819819

820820
def jacob(self):
821821
"""
822-
Velocity transform for Se(3)
822+
Velocity transform for SE(3)
823823
824824
:return: Jacobian matrix
825825
:rtype: numpy.ndarray, shape=(6,6)
826826
827-
``SEO.jacob`` is the 6x6 adjoint matrix
828-
829-
If spatial velocity :math:`\nu = (v_x, v_y, v_z, \omega_x, \omega_y, \omega_z)^T`
830-
and the SE(3) represents the pose of {B} relative to {A},
831-
ie. :math:`{}^A {\bf T}_B, and the adjoint is :math:`\mathbf{A}` then
832-
:math:`{}^{A}\!\nu = \mathbf{A} {}^{B}\!\nu`.
827+
``SE3.jacob()`` is the 6x6 Jacobian that maps spatial velocity or
828+
differential motion from frame {B} to frame {A} where the pose of {B}
829+
relative to {A} is represented by the homogeneous transform T =
830+
:math:`{}^A {\bf T}_B`.
831+
832+
.. note::
833+
- To map from frame {A} to frame {B} use the transpose of this matrix.
834+
- Use this method to map velocities between the robot end-effector frame
835+
and the base frames.
833836
834837
.. warning:: Do not use this method to map velocities between two frames
835838
on the same rigid-body.
836-
837-
.. note:: Use this method to map velocities between robot base and
838-
end-effector frames, rather than ``Ad()``.
839839
840840
:seealso: SE3.Ad, Twist.ad, :func:`~spatialmath.base.tr2jac`
841841
:Reference: Robotics, Vision & Control: Second Edition, P. Corke, Springer 2016; p65.
842842
:SymPy: supported
843843
"""
844-
return base.tr2jac(self.A, samebody=False)
844+
return base.tr2jac(self.A)
845845

846846
def Twist3(self):
847847
"""

0 commit comments

Comments
 (0)