Skip to content

Commit 1c4a618

Browse files
committed
Update documentation
1 parent 92d0422 commit 1c4a618

49 files changed

Lines changed: 129 additions & 107 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎2d_pose_twist.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -717,11 +717,11 @@ <h1>se(2) twist<a class="headerlink" href="#se-2-twist" title="Link to this head
717717
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span><span class="w"> </span><span class="nn">spatialmath</span><span class="w"> </span><span class="kn">import</span> <a class="sphinx-codeautolink-a" href="3d_pose_twist.html#spatialmath.twist.Twist3" title="spatialmath.twist.Twist3"><span class="n">Twist3</span></a>
718718
<span class="gp">&gt;&gt;&gt; </span><a class="sphinx-codeautolink-a" href="3d_pose_twist.html#spatialmath.twist.Twist3" title="spatialmath.twist.Twist3"><span class="n">S</span></a> <span class="o">=</span> <a class="sphinx-codeautolink-a" href="3d_pose_twist.html#spatialmath.twist.Twist3" title="spatialmath.twist.Twist3"><span class="n">Twist3</span></a><span class="p">(</span><span class="n">SE3</span><span class="o">.</span><span class="n">Rand</span><span class="p">())</span>
719719
<span class="gp">&gt;&gt;&gt; </span><a class="sphinx-codeautolink-a" href="3d_pose_twist.html#spatialmath.twist.Twist3" title="spatialmath.twist.Twist3"><span class="n">S</span></a>
720-
<span class="go">Twist3([-0.92405, -0.53998, -1.2676, -0.68575, -2.3379, 1.6667])</span>
720+
<span class="go">Twist3([-0.56161, -0.17775, -1.4684, -2.5655, 0.54875, 0.025398])</span>
721721
<span class="gp">&gt;&gt;&gt; </span><a class="sphinx-codeautolink-a" href="3d_pose_twist.html#spatialmath.twist.Twist3.inv" title="spatialmath.twist.Twist3.inv"><span class="n">S</span><span class="o">.</span><span class="n">inv</span></a><span class="p">()</span>
722-
<span class="go">Twist3([0.92405, 0.53998, 1.2676, 0.68575, 2.3379, -1.6667])</span>
722+
<span class="go">Twist3([0.56161, 0.17775, 1.4684, 2.5655, -0.54875, -0.025398])</span>
723723
<span class="gp">&gt;&gt;&gt; </span><a class="sphinx-codeautolink-a" href="3d_pose_twist.html#spatialmath.twist.Twist3" title="spatialmath.twist.Twist3"><span class="n">S</span></a> <span class="o">*</span> <a class="sphinx-codeautolink-a" href="3d_pose_twist.html#spatialmath.twist.Twist3.inv" title="spatialmath.twist.Twist3.inv"><span class="n">S</span><span class="o">.</span><span class="n">inv</span></a><span class="p">()</span>
724-
<span class="go">Twist3([1.1102e-16, 0, -2.2204e-16, 0, 0, 0])</span>
724+
<span class="go">Twist3([5.7778e-34, -2.2204e-16, -1.9429e-16, 0, 1.3878e-17, 6.9389e-18])</span>
725725
</pre></div>
726726
</div>
727727
</dd></dl>

‎3d_orient_SO3.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -491,9 +491,9 @@ <h1>SO(3) matrix<a class="headerlink" href="#so-3-matrix" title="Link to this he
491491
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span><span class="w"> </span><span class="nn">spatialmath</span><span class="w"> </span><span class="kn">import</span> <a class="sphinx-codeautolink-a" href="3d_orient_SO3.html#spatialmath.pose3d.SO3" title="spatialmath.pose3d.SO3"><span class="n">SO3</span></a>
492492
<span class="gp">&gt;&gt;&gt; </span><a class="sphinx-codeautolink-a" href="3d_orient_SO3.html#spatialmath.pose3d.SO3" title="spatialmath.pose3d.SO3"><span class="n">x</span></a> <span class="o">=</span> <a class="sphinx-codeautolink-a" href="3d_orient_SO3.html#spatialmath.pose3d.SO3.Rand" title="spatialmath.pose3d.SO3.Rand"><span class="n">SO3</span><span class="o">.</span><span class="n">Rand</span></a><span class="p">()</span>
493493
<span class="gp">&gt;&gt;&gt; </span><a class="sphinx-codeautolink-a" href="3d_orient_SO3.html#spatialmath.pose3d.SO3" title="spatialmath.pose3d.SO3"><span class="n">x</span></a>
494-
<span class="go">SO3(array([[-0.3155, -0.084 , -0.9452],</span>
495-
<span class="go"> [-0.4501, -0.8636, 0.227 ],</span>
496-
<span class="go"> [-0.8354, 0.4971, 0.2347]]))</span>
494+
<span class="go">SO3(array([[-0.9699, 0.1125, -0.2159],</span>
495+
<span class="go"> [-0.2263, -0.0898, 0.9699],</span>
496+
<span class="go"> [ 0.0897, 0.9896, 0.1126]]))</span>
497497
</pre></div>
498498
</div>
499499
<dl class="field-list simple">

‎3d_orient_unitquaternion.html‎

Lines changed: 23 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -188,8 +188,9 @@ <h1>Unit quaternion<a class="headerlink" href="#unit-quaternion" title="Link to
188188
</div>
189189
<div class="admonition note">
190190
<p class="admonition-title">Note</p>
191-
<p><span class="math notranslate nohighlight">\(\theta = 0\)</span> the result in an identity quaternion, otherwise
192-
<code class="docutils literal notranslate"><span class="pre">V</span></code> must have a finite length, ie. <span class="math notranslate nohighlight">\(|V| &gt; 0\)</span>.</p>
191+
<p>If <span class="math notranslate nohighlight">\(\theta\)</span> is zero within the default tolerance of
192+
<a class="reference internal" href="func_vector.html#spatialmath.base.vectors.iszero" title="spatialmath.base.vectors.iszero"><code class="xref py py-func docutils literal notranslate"><span class="pre">iszero()</span></code></a>, the result is an identity
193+
quaternion. Otherwise, <code class="docutils literal notranslate"><span class="pre">v</span></code> must have a nonzero norm.</p>
193194
</div>
194195
<dl class="field-list simple">
195196
<dt class="field-odd">Seealso<span class="colon">:</span></dt>
@@ -293,46 +294,27 @@ <h1>Unit quaternion<a class="headerlink" href="#unit-quaternion" title="Link to
293294
<dl class="py method">
294295
<dt class="sig sig-object py" id="spatialmath.quaternion.UnitQuaternion.OA">
295296
<span class="property"><span class="k"><span class="pre">classmethod</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">OA</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">o</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">a</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/spatialmath/quaternion.html#UnitQuaternion.OA"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#spatialmath.quaternion.UnitQuaternion.OA" title="Link to this definition"></a></dt>
296-
<dd><blockquote>
297-
<div><p>Construct a new unit quaternion from two vectors</p>
297+
<dd><p>Construct a new unit quaternion from two vectors</p>
298298
<dl class="field-list simple">
299-
<dt class="field-odd">param o<span class="colon">:</span></dt>
300-
<dd class="field-odd"><p>3-vector parallel to Y- axis</p>
301-
</dd>
302-
<dt class="field-even">type o<span class="colon">:</span></dt>
303-
<dd class="field-even"><p>array_like</p>
304-
</dd>
305-
<dt class="field-odd">param a<span class="colon">:</span></dt>
306-
<dd class="field-odd"><p>3-vector parallel to the Z-axis</p>
307-
</dd>
308-
<dt class="field-even">type a<span class="colon">:</span></dt>
309-
<dd class="field-even"><p>array_like</p>
299+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
300+
<dd class="field-odd"><ul class="simple">
301+
<li><p><strong>o</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>], <code class="xref py py-data docutils literal notranslate"><span class="pre">Tuple</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>], <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.5)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code></a>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Tuple</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code>[<span class="highlight sphinx_autodoc_typehints-value"><code class="docutils literal notranslate"><span class="mi"><span class="pre">3</span></span></code></span>]], <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v2.5)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dtype</span></code></a>[<a class="reference external" href="https://numpy.org/doc/stable/reference/arrays.scalars.html#numpy.floating" title="(in NumPy v2.5)"><code class="xref py py-class docutils literal notranslate"><span class="pre">floating</span></code></a>]]]</span>) – 3-vector parallel to Y- axis</p></li>
302+
<li><p><strong>a</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>], <code class="xref py py-data docutils literal notranslate"><span class="pre">Tuple</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>], <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.5)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code></a>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Tuple</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code>[<span class="highlight sphinx_autodoc_typehints-value"><code class="docutils literal notranslate"><span class="mi"><span class="pre">3</span></span></code></span>]], <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v2.5)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dtype</span></code></a>[<a class="reference external" href="https://numpy.org/doc/stable/reference/arrays.scalars.html#numpy.floating" title="(in NumPy v2.5)"><code class="xref py py-class docutils literal notranslate"><span class="pre">floating</span></code></a>]]]</span>) – 3-vector parallel to the Z-axis</p></li>
303+
</ul>
310304
</dd>
311-
<dt class="field-odd">return<span class="colon">:</span></dt>
312-
<dd class="field-odd"><p>unit-quaternion</p>
305+
<dt class="field-even">Returns<span class="colon">:</span></dt>
306+
<dd class="field-even"><p>unit-quaternion</p>
313307
</dd>
314-
<dt class="field-even">rtype<span class="colon">:</span></dt>
315-
<dd class="field-even"><p>UnitQuaternion instance</p>
308+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
309+
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="#spatialmath.quaternion.UnitQuaternion" title="spatialmath.quaternion.UnitQuaternion"><code class="xref py py-class docutils literal notranslate"><span class="pre">UnitQuaternion</span></code></a></span></p>
316310
</dd>
317311
</dl>
318312
<p><code class="docutils literal notranslate"><span class="pre">UnitQuaternion.OA(O,</span> <span class="pre">A)</span></code> is a unit quaternion that describes the 3D rotation
319313
defined in terms of vectors parallel to the Y- and Z-axes of its reference
320-
frame, respectively :math:<a href="#id1"><span class="problematic" id="id2">`</span></a></p>
321-
</div></blockquote>
322-
<p>ec{o}` and :math:`
323-
ec{a}`. In robotics these axes</p>
324-
<blockquote>
325-
<div><p>are respectively called the orientation and approach vectors defined such that
326-
:math:<a href="#id3"><span class="problematic" id="id4">`</span></a>mat{R}=[</p>
327-
</div></blockquote>
328-
<p>ec{n},
329-
ec{o},
330-
ec{a}]` and :math:`
331-
ec{n} =
332-
ec{o} imes
333-
ec{a}`.</p>
334-
<blockquote>
335-
<div><p>Example:</p>
314+
frame, respectively <span class="math notranslate nohighlight">\(\vec{o}\)</span> and <span class="math notranslate nohighlight">\(\vec{a}\)</span>. In robotics these axes
315+
are respectively called the orientation and approach vectors defined such that
316+
<span class="math notranslate nohighlight">\(\mat{R}=[\vec{n}, \vec{o}, \vec{a}]\)</span> and <span class="math notranslate nohighlight">\(\vec{n} = \vec{o} \times \vec{a}\)</span>.</p>
317+
<p>Example:</p>
336318
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span><span class="w"> </span><span class="nn">spatialmath</span><span class="w"> </span><span class="kn">import</span> <a class="sphinx-codeautolink-a" href="3d_orient_unitquaternion.html#spatialmath.quaternion.UnitQuaternion" title="spatialmath.quaternion.UnitQuaternion"><span class="n">UnitQuaternion</span></a> <span class="k">as</span> <span class="n">UQ</span>
337319
<span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><a class="sphinx-codeautolink-a" href="3d_orient_unitquaternion.html#spatialmath.quaternion.UnitQuaternion.OA" title="spatialmath.quaternion.UnitQuaternion.OA"><span class="n">UQ</span><span class="o">.</span><span class="n">OA</span></a><span class="p">([</span><span class="mi">0</span><span class="p">,</span><span class="mi">0</span><span class="p">,</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span><span class="mi">1</span><span class="p">,</span><span class="mi">0</span><span class="p">]))</span>
338320
<span class="go"> 0.7071 &lt;&lt; -0.7071, 0.0000, -0.0000 &gt;&gt;</span>
@@ -344,20 +326,14 @@ <h1>Unit quaternion<a class="headerlink" href="#unit-quaternion" title="Link to
344326
<li><p>Only the <code class="docutils literal notranslate"><span class="pre">A</span></code> vector is guaranteed to have the same direction in the resulting
345327
rotation matrix</p></li>
346328
<li><p><code class="docutils literal notranslate"><span class="pre">O</span></code> and <code class="docutils literal notranslate"><span class="pre">A</span></code> do not have to be unit-length, they are normalized</p></li>
347-
<li><p><code class="docutils literal notranslate"><span class="pre">O</span></code> and <a href="#id5"><span class="problematic" id="id6">``</span></a>A` do not have to be orthogonal, so long as they are not parallel</p></li>
329+
<li><p><code class="docutils literal notranslate"><span class="pre">O</span></code> and <a href="#id1"><span class="problematic" id="id2">``</span></a>A` do not have to be orthogonal, so long as they are not parallel</p></li>
348330
</ul>
349331
</div>
350332
<dl class="field-list simple">
351-
<dt class="field-odd">seealso<span class="colon">:</span></dt>
333+
<dt class="field-odd">Seealso<span class="colon">:</span></dt>
352334
<dd class="field-odd"><p><a class="reference internal" href="func_3d.html#spatialmath.base.transforms3d.oa2r" title="spatialmath.base.transforms3d.oa2r"><code class="xref py py-func docutils literal notranslate"><span class="pre">oa2r()</span></code></a></p>
353335
</dd>
354336
</dl>
355-
</div></blockquote>
356-
<dl class="field-list simple">
357-
<dt class="field-odd">Return type<span class="colon">:</span></dt>
358-
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="#spatialmath.quaternion.UnitQuaternion" title="spatialmath.quaternion.UnitQuaternion"><code class="xref py py-class docutils literal notranslate"><span class="pre">UnitQuaternion</span></code></a></span></p>
359-
</dd>
360-
</dl>
361337
</dd></dl>
362338
<dl class="py method">
363339
<dt class="sig sig-object py" id="spatialmath.quaternion.UnitQuaternion.Pure">
@@ -464,11 +440,11 @@ <h1>Unit quaternion<a class="headerlink" href="#unit-quaternion" title="Link to
464440
<p>Example:</p>
465441
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span><span class="w"> </span><span class="nn">spatialmath</span><span class="w"> </span><span class="kn">import</span> <a class="sphinx-codeautolink-a" href="3d_orient_unitquaternion.html#spatialmath.quaternion.UnitQuaternion" title="spatialmath.quaternion.UnitQuaternion"><span class="n">UnitQuaternion</span></a> <span class="k">as</span> <span class="n">UQ</span>
466442
<span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><a class="sphinx-codeautolink-a" href="3d_orient_unitquaternion.html#spatialmath.quaternion.UnitQuaternion.Rand" title="spatialmath.quaternion.UnitQuaternion.Rand"><span class="n">UQ</span><span class="o">.</span><span class="n">Rand</span></a><span class="p">())</span>
467-
<span class="go"> 0.6505 &lt;&lt; 0.5409, -0.3045, -0.4376 &gt;&gt;</span>
443+
<span class="go"> 0.8631 &lt;&lt; -0.1106, -0.4904, -0.0481 &gt;&gt;</span>
468444
<span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><a class="sphinx-codeautolink-a" href="3d_orient_unitquaternion.html#spatialmath.quaternion.UnitQuaternion.Rand" title="spatialmath.quaternion.UnitQuaternion.Rand"><span class="n">UQ</span><span class="o">.</span><span class="n">Rand</span></a><span class="p">(</span><span class="mi">3</span><span class="p">))</span>
469-
<span class="go"> 0.1463 &lt;&lt; 0.5488, 0.0926, -0.8178 &gt;&gt;</span>
470-
<span class="go"> 0.3079 &lt;&lt; -0.5954, -0.6234, 0.4027 &gt;&gt;</span>
471-
<span class="go"> 0.4731 &lt;&lt; -0.2257, -0.7909, 0.3158 &gt;&gt;</span>
445+
<span class="go"> 0.5630 &lt;&lt; 0.3922, -0.5539, 0.4717 &gt;&gt;</span>
446+
<span class="go"> 0.3069 &lt;&lt; 0.6437, 0.0881, 0.6955 &gt;&gt;</span>
447+
<span class="go"> 0.7994 &lt;&lt; -0.3575, -0.2918, -0.3846 &gt;&gt;</span>
472448
</pre></div>
473449
</div>
474450
<dl class="field-list simple">

‎3d_pose_SE3.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -589,13 +589,13 @@ <h1>SE(3) matrix<a class="headerlink" href="#se-3-matrix" title="Link to this he
589589
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span><span class="w"> </span><span class="nn">spatialmath</span><span class="w"> </span><span class="kn">import</span> <a class="sphinx-codeautolink-a" href="3d_pose_SE3.html#spatialmath.pose3d.SE3" title="spatialmath.pose3d.SE3"><span class="n">SE3</span></a>
590590
<span class="gp">&gt;&gt;&gt; </span><a class="sphinx-codeautolink-a" href="3d_pose_SE3.html#spatialmath.pose3d.SE3.Rand" title="spatialmath.pose3d.SE3.Rand"><span class="n">SE3</span><span class="o">.</span><span class="n">Rand</span></a><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
591591
<span class="go">SE3([</span>
592-
<span class="go">array([[-0.643 , 0.2439, -0.726 , 0.2502],</span>
593-
<span class="go"> [ 0.1211, -0.9036, -0.4109, -0.6074],</span>
594-
<span class="go"> [-0.7562, -0.3521, 0.5515, -0.8555],</span>
592+
<span class="go">array([[ 0.4404, 0.8227, -0.3595, -0.3495],</span>
593+
<span class="go"> [ 0.8903, -0.4518, 0.0567, -0.0527],</span>
594+
<span class="go"> [-0.1158, -0.345 , -0.9314, -0.4697],</span>
595595
<span class="go"> [ 0. , 0. , 0. , 1. ]]),</span>
596-
<span class="go">array([[ 0.334 , 0.9425, -0.0122, 0.3554],</span>
597-
<span class="go"> [ 0.8723, -0.3042, 0.3828, -0.0723],</span>
598-
<span class="go"> [ 0.357 , -0.1385, -0.9238, 0.47 ],</span>
596+
<span class="go">array([[ 0.0199, 0.1247, 0.992 , 0.782 ],</span>
597+
<span class="go"> [ 0.8539, 0.5139, -0.0817, 0.5293],</span>
598+
<span class="go"> [-0.52 , 0.8487, -0.0963, -0.9875],</span>
599599
<span class="go"> [ 0. , 0. , 0. , 1. ]]) ])</span>
600600
</pre></div>
601601
</div>

0 commit comments

Comments
 (0)