Skip to content

Commit f0b08d3

Browse files
committed
Update documentation
1 parent 37b5d7b commit f0b08d3

59 files changed

Lines changed: 168 additions & 109 deletions

Some content is hidden

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

2d_ellipse-1.pdf

0 Bytes
Binary file not shown.

2d_ellipse-2.pdf

0 Bytes
Binary file not shown.

2d_orient_SO2-1.pdf

0 Bytes
Binary file not shown.

2d_polygon-1.pdf

0 Bytes
Binary file not shown.

2d_polygon-2.pdf

0 Bytes
Binary file not shown.

2d_pose_SE2-1.pdf

0 Bytes
Binary file not shown.

2d_pose_twist.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -701,11 +701,11 @@ <h1>se(2) twist<a class="headerlink" href="#se-2-twist" title="Permalink to this
701701
<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="nn">spatialmath</span> <span class="kn">import</span> <span class="n">Twist3</span>
702702
<span class="gp">&gt;&gt;&gt; </span><span class="n">S</span> <span class="o">=</span> <span class="n">Twist3</span><span class="p">(</span><span class="n">SE3</span><span class="o">.</span><span class="n">Rand</span><span class="p">())</span>
703703
<span class="gp">&gt;&gt;&gt; </span><span class="n">S</span>
704-
<span class="go">Twist3([-0.58708, -0.058682, -0.2815, -1.8069, 0.3976, 1.0293])</span>
704+
<span class="go">Twist3([-0.10433, 0.79314, -1.2976, 1.6354, 0.12838, -1.8001])</span>
705705
<span class="gp">&gt;&gt;&gt; </span><span class="n">S</span><span class="o">.</span><span class="n">inv</span><span class="p">()</span>
706-
<span class="go">Twist3([0.58708, 0.058682, 0.2815, 1.8069, -0.3976, -1.0293])</span>
706+
<span class="go">Twist3([0.10433, -0.79314, 1.2976, -1.6354, -0.12838, 1.8001])</span>
707707
<span class="gp">&gt;&gt;&gt; </span><span class="n">S</span> <span class="o">*</span> <span class="n">S</span><span class="o">.</span><span class="n">inv</span><span class="p">()</span>
708-
<span class="go">Twist3([0, -1.1102e-16, 0, 0, 0, 0])</span>
708+
<span class="go">Twist3([1.1102e-16, -2.2204e-16, 1.1102e-16, 0, 0, 0])</span>
709709
</pre></div>
710710
</div>
711711
</dd></dl>

3d_orient_SO3-1.pdf

0 Bytes
Binary file not shown.

3d_orient_SO3.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -504,9 +504,9 @@ <h1>SO(3) matrix<a class="headerlink" href="#so-3-matrix" title="Permalink to th
504504
<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="nn">spatialmath</span> <span class="kn">import</span> <span class="n">SO3</span>
505505
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span> <span class="o">=</span> <span class="n">SO3</span><span class="o">.</span><span class="n">Rand</span><span class="p">()</span>
506506
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span>
507-
<span class="go">SO3(array([[ 0.4519, 0.3502, 0.8204],</span>
508-
<span class="go"> [ 0.4866, -0.8676, 0.1023],</span>
509-
<span class="go"> [ 0.7477, 0.353 , -0.5625]]))</span>
507+
<span class="go">SO3(array([[ 0.122 , 0.7458, -0.6548],</span>
508+
<span class="go"> [-0.7537, 0.4989, 0.4278],</span>
509+
<span class="go"> [ 0.6458, 0.4413, 0.623 ]]))</span>
510510
</pre></div>
511511
</div>
512512
<dl class="field-list simple">

3d_orient_unitquaternion.html

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -451,11 +451,11 @@ <h1>Unit quaternion<a class="headerlink" href="#unit-quaternion" title="Permalin
451451
<p>Example:</p>
452452
<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="nn">spatialmath</span> <span class="kn">import</span> <span class="n">UnitQuaternion</span> <span class="k">as</span> <span class="n">UQ</span>
453453
<span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">UQ</span><span class="o">.</span><span class="n">Rand</span><span class="p">())</span>
454-
<span class="go"> 0.6181 &lt;&lt; 0.3107, 0.2247, -0.6862 &gt;&gt;</span>
454+
<span class="go"> 0.4393 &lt;&lt; 0.5505, -0.6984, 0.1274 &gt;&gt;</span>
455455
<span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">UQ</span><span class="o">.</span><span class="n">Rand</span><span class="p">(</span><span class="mi">3</span><span class="p">))</span>
456-
<span class="go"> 0.3229 &lt;&lt; -0.6699, -0.0897, 0.6625 &gt;&gt;</span>
457-
<span class="go"> 0.4668 &lt;&lt; 0.0441, 0.5175, 0.7158 &gt;&gt;</span>
458-
<span class="go"> 0.4366 &lt;&lt; -0.2862, 0.0007, 0.8529 &gt;&gt;</span>
456+
<span class="go"> 0.4616 &lt;&lt; 0.0839, -0.3794, -0.7975 &gt;&gt;</span>
457+
<span class="go"> 0.5928 &lt;&lt; 0.0547, -0.4588, -0.6596 &gt;&gt;</span>
458+
<span class="go"> 0.4361 &lt;&lt; -0.2856, -0.6933, 0.4976 &gt;&gt;</span>
459459
</pre></div>
460460
</div>
461461
<dl class="field-list simple">
@@ -1604,11 +1604,14 @@ <h1>Unit quaternion<a class="headerlink" href="#unit-quaternion" title="Permalin
16041604

16051605
<dl class="py method">
16061606
<dt class="sig sig-object py" id="spatialmath.quaternion.UnitQuaternion.exp">
1607-
<span class="sig-name descname"><span class="pre">exp</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#spatialmath.quaternion.UnitQuaternion.exp" title="Permalink to this definition"></a></dt>
1607+
<span class="sig-name descname"><span class="pre">exp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tol</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">100</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#spatialmath.quaternion.UnitQuaternion.exp" title="Permalink to this definition"></a></dt>
16081608
<dd><p>Exponential of quaternion</p>
16091609
<dl class="field-list simple">
1610-
<dt class="field-odd">Return type</dt>
1611-
<dd class="field-odd"><p>Quaternion instance</p>
1610+
<dt class="field-odd">Parameters</dt>
1611+
<dd class="field-odd"><p><strong>tol</strong> (<em>float</em><em>, </em><em>optional</em>) – Tolerance when checking for pure quaternion, in multiples of eps, defaults to 100</p>
1612+
</dd>
1613+
<dt class="field-even">Return type</dt>
1614+
<dd class="field-even"><p>Quaternion instance</p>
16121615
</dd>
16131616
</dl>
16141617
<p><code class="docutils literal notranslate"><span class="pre">q.exp()</span></code> is the exponential of the quaternion <code class="docutils literal notranslate"><span class="pre">q</span></code>, ie.</p>

0 commit comments

Comments
 (0)