Skip to content

Commit

Permalink
docs: add missing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
David Torres Ocana (TME) committed May 5, 2023
1 parent 76d8d92 commit e3f91d2
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion dgp/utils/pose.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,9 @@ def inverse(self, new_reference_coordinate_system=""):
Returns
----------
result: Pose
Inverted pose
new_reference_coordinate_system pose
reference_coordinate_system: str
The reference coordinate system the inverse Pose (Transform) is expressed with respect to. I.e. the name of the current Pose
"""
qinv = self.quat.inverse
return self.__class__(qinv, qinv.rotate(-self.tvec),
Expand Down Expand Up @@ -149,6 +151,8 @@ def from_matrix(cls, transformation_matrix, reference_coordinate_system=""):
----------
transformation_matrix: np.ndarray
4x4 containing rotation/translation
reference_coordinate_system: str
Reference coordinate system this Pose (Transform) is expressed with respect to
Returns
-------
Expand All @@ -168,6 +172,8 @@ def from_rotation_translation(cls, rotation_matrix, tvec, reference_coordinate_s
3x3 rotation matrix
tvec : np.ndarray
length-3 translation vector
reference_coordinate_system: str
Reference coordinate system this Pose (Transform) is expressed with respect to
"""
return cls(wxyz=Quaternion(matrix=rotation_matrix), tvec=np.float64(tvec),
reference_coordinate_system=reference_coordinate_system)
Expand Down

0 comments on commit e3f91d2

Please sign in to comment.