8000 deprecate AngVec in favour of AngleAxis · krishanrana/spatialmath-python@4bf3a8a · GitHub
[go: up one dir, main page]

Skip to content

Commit 4bf3a8a

Browse files
committed
deprecate AngVec in favour of AngleAxis
1 parent 65ec09d commit 4bf3a8a

File tree

1 file changed

+53
-5
lines changed

1 file changed

+53
-5
lines changed

spatialmath/pose3d.py

Lines changed: 53 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -537,7 +537,7 @@ def OA(cls, o, a):
537537
return cls(base.oa2r(o, a), check=False)
538538

539539
@classmethod
540-
def AngVec(cls, theta, v, *, unit='rad'):
540+
def AngleAxis(cls, theta, v, *, unit='rad'):
541541
r"""
542542
Construct a new SO(3) rotation matrix from rotation angle and axis
543543
@@ -550,7 +550,7 @@ def AngVec(cls, theta, v, *, unit='rad'):
550550
:return: SO(3) rotation
551551
:rtype: SO3 instance
552552
553-
``SO3.AngVec(theta, V)`` is an SO(3) rotation defined by
553+
``SO3.AngleAxis(theta, V)`` is an SO(3) rotation defined by
554554
a rotation of ``THETA`` about the vector ``V``.
555555
556556
.. note:: :math:`\theta \eq 0` the result in an identity matrix, otherwise
@@ -559,6 +559,30 @@ def AngVec(cls, theta, v, *, unit='rad'):
559559
:seealso: :func:`~spatialmath.pose3d.SE3.angvec`, :func:`spatialmath.base.transforms3d.angvec2r`
560560
"""
561561
return cls(base.angvec2r(theta, v, unit=unit), check=False)
562+
563+
@classmethod
564+
def AngVec(cls, theta, v, *, unit='rad'):
565+
r"""
566+
Construct a new SO(3) rotation matrix from rotation angle and axis
567+
568+
:param theta: rotation
569+
:type theta: float
570+
:param unit: angular units: 'rad' [default], or 'deg'
571+
:type unit: str
572+
:param v: rotation axis, 3-vector
10000 573+
:type v: array_like
574+
:return: SO(3) rotation
575+
:rtype: SO3 instance
576+
577+
``SO3.AngVec(theta, V)`` is an SO(3) rotation defined by
578+
a rotation of ``THETA`` about the vector ``V``.
579+
580+
.. deprecated:: 0.9.8
581+
Use :meth:`AngleAxis` instead.
582+
583+
:seealso: :func:`~spatialmath.pose3d.SE3.angvec`, :func:`spatialmath.base.transforms3d.angvec2r`
584+
"""
585+
return cls(base.angvec2r(theta, v, unit=unit), check=False)
562586

563587
@classmethod
564588
def EulerVec(cls, w):
@@ -1250,7 +1274,7 @@ def OA(cls, o, a):
12501274
return cls(base.oa2tr(o, a), check=False)
12511275

12521276
@classmethod
1253-
def AngVec(cls, theta, v, *, unit='rad'):
1277+
def AngleAxis(cls, theta, v, *, unit='rad'):
12541278
r"""
12551279
Create an SE(3) pure rotation matrix from rotation angle and axis
12561280
@@ -1263,7 +1287,7 @@ def AngVec(cls, theta, v, *, unit='rad'):
12631287
:return: SE(3) matrix
12641288
:rtype: SE3 instance
12651289
1266-
``SE3.AngVec(θ, v)`` is an SE(3) rotation defined by
1290+
``SE3.AngleAxis(θ, v)`` is an SE(3) rotation defined by
12671291
a rotation of ``θ`` about the vector ``v``.
12681292
12691293
.. math::
@@ -1278,6 +1302,30 @@ def AngVec(cls, theta, v, *, unit='rad'):
12781302
"""
12791303
return cls(base.angvec2tr(theta, v, unit=unit), check=False)
12801304

1305+
@classmethod
1306+
def AngVec(cls, theta, v, *, unit='rad'):
1307+
r"""
1308+
Create an SE(3) pure rotation matrix from rotation angle and axis
1309+
1310+
:param θ: rotation
1311+
:type θ: float
1312+
:param unit: angular units: 'rad' [default], or 'deg'
1313+
:type unit: str
1314+
:param v: rotation axis, 3-vector
1315+
:type v: array_like
1316+
:return: SE(3) matrix
1317+
:rtype: SE3 instance
1318+
1319+
``SE3.AngVec(θ, v)`` is an SE(3) rotation defined by
1320+
a rotation of ``θ`` about the vector ``v``.
1321+
1322+
.. deprecated:: 0.9.8
1323+
Use :meth:`AngleAxis` instead.
1324+
1325+
:seealso: :func:`~spatialmath.pose3d.SE3.angvec`, :func:`~spatialmath.pose3d.SE3.EulerVec`, :func:`~spatialmath.base.transforms3d.angvec2r`
1326+
"""
1327+
return cls(base.angvec2tr(theta, v, unit=unit), check=False)
1328+
12811329
@classmethod
12821330
def EulerVec(cls, w):
12831331
r"""
@@ -1396,7 +1444,7 @@ def Ty(cls, y):
13961444
.. runblock:: pycon
13971445
13981446
>>> SE3.Ty(2)
1399-
>>> SE3.Tz([2,3])
1447+
>>> SE3.Ty([2,3])
14001448
14011449
14021450
:seealso: :func:`~spatialmath.base.transforms3d.transl`

0 commit comments

Comments
 (0)
0