You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/intro.rst
+34-10Lines changed: 34 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,9 @@ Introduction
7
7
Spatial maths capability underpins all of robotics and robotic vision.
8
8
It provides the means to describe the relative position and orientation of objects in 2D or 3D space.
9
9
This package provides Python classes and functions to represent, print, plot, manipulate and covert between such representations.
10
-
This includes relevant mathematical objects such as rotation matrices :math:`R \in SO(2), SO(3)`, homogeneous transformation matrices :math:`T \in SE(2), SE(3)` and quaternions :math:`q \in\mathbb{H}`.
10
+
This includes relevant mathematical objects such as rotation matrices :math:`R \in SO(2), SO(3)`,
For example, we can create a rigid-body transformation that is a rotation about the x-axis of 30 degrees::
13
15
@@ -20,7 +22,7 @@ For example, we can create a rigid-body transformation that is a rotation about
20
22
which results in a NumPy 4x4 array that belongs to the group SE(3). We could also create a class instance::
21
23
22
24
>>> from spatialmath import *
23
-
>>> T = sm.SE3.Rx(30, 'deg')
25
+
>>> T = SE3.Rx(30, 'deg')
24
26
>>> type(T)
25
27
<class 'spatialmath.pose3d.SE3'>
26
28
>>> print(T)
@@ -40,9 +42,19 @@ While functions and classes can provide similar functionality the class provide
40
42
41
43
42
44
Relationship to MATLAB tools
43
-
============================
45
+
----------------------------
44
46
This package replicates, as much as possible, the functionality of the `Spatial Math Toolbox <https://github.com/petercorke/spatial-math>`__ for MATLAB |reg|
45
-
which underpins the `Robotics Toolbox <https://github.com/petercorke/robotics-toolbox-matlab>`__ for MATLAB.
47
+
which underpins the `Robotics Toolbox <https://github.com/petercorke/robotics-toolbox-matlab>`__ for MATLAB. It comprises:
48
+
49
+
* the *classic* functions (which date back to the origin of the Robotics Toolbox for MATLAB) such as ``rotx``, ``trotz``, ``eul2tr`` etc. as the ``base`` package which you can access by::
50
+
51
+
from spatialmath.base import *
52
+
53
+
and works with NumPy arrays. This package also includes a set of functions to deal with quaternions and unit-quaternions represented as 4-element
54
+
Numpy arrays.
55
+
* the classes (which appeared in Robotics Toolbox for MATLAB release 10 in 2017) such as ``SE3``, ``UnitQuaternion`` etc. The only significant difference
56
+
is that the MATLAB ``Twist`` class is now called ``Twist3``.
57
+
46
58
The design considerations included:
47
59
48
60
- being as similar as possible to the MATLAB Toolbox function names and semantics
@@ -57,7 +69,19 @@ The design considerations included:
57
69
Spatial math classes
58
70
====================
59
71
60
-
The package provides classes to abstract and implementing appropriate operations for the following groups:
72
+
The package provides classes to represent pose and orientation in 3D and 2D
73
+
space:
74
+
75
+
============ ================== =============
76
+
Represents in 3D in 2D
77
+
============ ================== =============
78
+
pose ``SE3`` ``SE2``
79
+
``Twist3`` ``Twist2``
80
+
orientation ``SO3`` ``SO2``
81
+
``UnitQuaternion``
82
+
============ ================== =============
83
+
84
+
These classes to abstract and implementing appropriate operations for the following groups:
0 commit comments