Skip to content

Commit e9dc03f

Browse files
committed
Add doc string.
1 parent 22a6ca5 commit e9dc03f

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

spatialmath/pose3d.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1163,6 +1163,16 @@ def inv(self) -> SE3:
11631163
return SE3([smb.trinv(x) for x in self.A], check=False)
11641164

11651165
def SE2(self) -> SE2:
1166+
"""
1167+
Create SE(2) from SE(3)
1168+
1169+
:return: SE(2) with same rotation as the yaw angle using the 'zyx' convention,
1170+
and translation in x,y
1171+
:rtype: SE2 instance
1172+
1173+
"Flattens" 3D rigid-body motion to 2D, along the z axis.
1174+
1175+
"""
11661176
if len(self) == 1:
11671177
return SE2(self.x, self.y, self.rpy()[2])
11681178
else:

0 commit comments

Comments
 (0)