Skip to content

Commit e0ecc8e

Browse files
committed
update docstring
1 parent 8480019 commit e0ecc8e

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/aspire/utils/coor_trans.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -155,8 +155,10 @@ def mean_aligned_angular_distance(rots_est, rots_gt, degree_tol=None):
155155
Register estimates to ground truth rotations and compute the
156156
mean angular distance between them (in degrees).
157157
158-
:param rots_est: A set of estimated rotations of size nx3x3.
159-
:param rots_gt: A set of ground truth rotations of size nx3x3.
158+
:param rots_est: A set of estimated rotations. A Rotation object or
159+
array of size nx3x3.
160+
:param rots_gt: A set of ground truth rotations. A Rotation object or
161+
array of size nx3x3.
160162
:param degree_tol: Option to assert if the mean angular distance is
161163
less than `degree_tol` degrees. If `None`, returns the mean
162164
aligned angular distance.

0 commit comments

Comments
 (0)