Skip to content

Commit 4756544

Browse files
committed
Update documentation
1 parent c4dde0e commit 4756544

47 files changed

Lines changed: 42 additions & 46 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.

‎3d_line.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -831,7 +831,7 @@ <h1>3D line<a class="headerlink" href="#d-line" title="Link to this heading">
831831
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
832832
<dd class="field-odd"><ul class="simple">
833833
<li><p><strong>l2</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="#spatialmath.geom3d.Line3" title="spatialmath.geom3d.Line3"><code class="xref py py-class docutils literal notranslate"><span class="pre">Line3</span></code></a></span>) – Second line</p></li>
834-
<li><p><strong>tol</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></span>) – Tolerance in multiples of eps, defaults to 20</p></li>
834+
<li><p><strong>tol</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></span>) – Parallel-direction tolerance in multiples of eps, defaults to 20</p></li>
835835
</ul>
836836
</dd>
837837
<dt class="field-even">Returns<span class="colon">:</span></dt>

‎3d_orient_SO3.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -505,9 +505,9 @@ <h1>SO(3) matrix<a class="headerlink" href="#so-3-matrix" title="Link to this he
505505
<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> <span class="n">SO3</span>
506506
<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>
507507
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span>
508-
<span class="go">SO3(array([[-0.65834209, -0.50663644, -0.55669131],</span>
509-
<span class="go"> [ 0.61884009, -0.78533037, -0.01712169],</span>
510-
<span class="go"> [-0.42851212, -0.35577483, 0.83054298]]))</span>
508+
<span class="go">SO3(array([[ 0.35286102, -0.58908573, -0.72695743],</span>
509+
<span class="go"> [-0.6279443 , 0.42689178, -0.65072988],</span>
510+
<span class="go"> [ 0.69366783, 0.68610598, -0.21927956]]))</span>
511511
</pre></div>
512512
</div>
513513
<dl class="field-list simple">

‎3d_orient_unitquaternion.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -467,11 +467,11 @@ <h1>Unit quaternion<a class="headerlink" href="#unit-quaternion" title="Link to
467467
<p>Example:</p>
468468
<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> <span class="n">UnitQuaternion</span> <span class="k">as</span> <span class="n">UQ</span>
469469
<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>
470-
<span class="go"> 0.3185 &lt;&lt; 0.0267, -0.3336, 0.8869 &gt;&gt;</span>
470+
<span class="go"> 0.8117 &lt;&lt; 0.1065, 0.5688, 0.0788 &gt;&gt;</span>
471471
<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>
472-
<span class="go"> 0.3123 &lt;&lt; 0.1570, -0.0774, 0.9337 &gt;&gt;</span>
473-
<span class="go"> 0.0671 &lt;&lt; -0.8686, 0.0988, -0.4810 &gt;&gt;</span>
474-
<span class="go"> 0.0652 &lt;&lt; -0.0662, 0.3384, -0.9364 &gt;&gt;</span>
472+
<span class="go"> 0.5940 &lt;&lt; -0.0601, 0.6547, -0.4637 &gt;&gt;</span>
473+
<span class="go"> 0.1739 &lt;&lt; 0.1896, 0.8998, -0.3523 &gt;&gt;</span>
474+
<span class="go"> 0.6101 &lt;&lt; -0.4159, -0.5949, 0.3176 &gt;&gt;</span>
475475
</pre></div>
476476
</div>
477477
<dl class="field-list simple">

‎3d_pose_SE3.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -606,13 +606,13 @@ <h1>SE(3) matrix<a class="headerlink" href="#se-3-matrix" title="Link to this he
606606
<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> <span class="n">SE3</span>
607607
<span class="gp">&gt;&gt;&gt; </span><span class="n">SE3</span><span class="o">.</span><span class="n">Rand</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
608608
<span class="go">SE3([</span>
609-
<span class="go">array([[ 0.74712604, -0.24591071, -0.61751971, 0.16170803],</span>
610-
<span class="go"> [-0.64957893, -0.07320597, -0.75676159, -0.09802942],</span>
611-
<span class="go"> [ 0.14088966, 0.96652409, -0.2144325 , -0.58133694],</span>
609+
<span class="go">array([[ 0.12502436, -0.72128112, -0.68126533, -0.2692333 ],</span>
610+
<span class="go"> [ 0.88144492, -0.23445217, 0.40998419, 0.87813329],</span>
611+
<span class="go"> [-0.45543799, -0.65175588, 0.60645735, 0.77106558],</span>
612612
<span class="go"> [ 0. , 0. , 0. , 1. ]]),</span>
613-
<span class="go">array([[ 0.3900494 , 0.84334632, 0.36963287, 0.03601579],</span>
614-
<span class="go"> [ 0.76512204, -0.52018727, 0.3794647 , -0.86239152],</span>
615-
<span class="go"> [ 0.51229847, 0.13480427, -0.84816159, -0.17347396],</span>
613+
<span class="go">array([[-0.20181018, 0.31249362, 0.9282351 , -0.14478929],</span>
614+
<span class="go"> [-0.91025571, 0.289995 , -0.29552907, 0.6568073 ],</span>
615+
<span class="go"> [-0.36153449, -0.90457207, 0.22592516, -0.17688753],</span>
616616
<span class="go"> [ 0. , 0. , 0. , 1. ]]) ])</span>
617617
</pre></div>
618618
</div>

‎3d_pose_dualquaternion.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -197,14 +197,14 @@ <h1>Unit dual quaternion<a class="headerlink" href="#unit-dual-quaternion" title
197197
<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> <span class="n">UnitDualQuaternion</span><span class="p">,</span> <span class="n">SE3</span>
198198
<span class="gp">&gt;&gt;&gt; </span><span class="n">T</span> <span class="o">=</span> <span class="n">SE3</span><span class="o">.</span><span class="n">Rand</span><span class="p">()</span>
199199
<span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">T</span><span class="p">)</span>
200-
<span class="go"> -0.736 -0.005501 -0.6769 -0.3207 </span>
201-
<span class="go"> -0.6766 0.03783 0.7354 -0.3936 </span>
202-
<span class="go"> 0.02156 0.9993 -0.03157 -0.06855 </span>
200+
<span class="go"> -0.1631 -0.3934 -0.9048 -0.2417 </span>
201+
<span class="go"> 0.3465 0.8358 -0.4258 -0.2952 </span>
202+
<span class="go"> 0.9238 -0.383 -5.613e-05 0.9697 </span>
203203
<span class="go"> 0 0 0 1 </span>
204204

205205
<span class="gp">&gt;&gt;&gt; </span><span class="n">d</span> <span class="o">=</span> <span class="n">UnitDualQuaternion</span><span class="p">(</span><span class="n">T</span><span class="p">)</span>
206206
<span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">d</span><span class="p">)</span>
207-
<span class="go">-0.2599 &lt;&lt; -0.2538, 0.6718, 0.6455 &gt;&gt; + ε 0.1137 &lt; -0.0623, 0.1634, -0.1488 &gt;</span>
207+
<span class="go">-0.6467 &lt;&lt; -0.0166, 0.7069, -0.2860 &gt;&gt; + ε 0.2410 &lt; -0.2224, 0.0528, -0.4014 &gt;</span>
208208
<span class="gp">&gt;&gt;&gt; </span><span class="nb">type</span><span class="p">(</span><span class="n">d</span><span class="p">)</span>
209209
<span class="go">&lt;class 'spatialmath.DualQuaternion.UnitDualQuaternion'&gt;</span>
210210
</pre></div>

‎3d_pose_twist.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -281,8 +281,8 @@ <h1>se(3) twist<a class="headerlink" href="#se-3-twist" title="Link to this head
281281
<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> <span class="n">Twist3</span>
282282
<span class="gp">&gt;&gt;&gt; </span><span class="n">Twist3</span><span class="o">.</span><span class="n">Rand</span><span class="p">(</span><span class="n">N</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
283283
<span class="go">Twist3([</span>
284-
<span class="go"> [-0.94063, -0.55005, 0.41504, 0.23279, 1.3564, -2.1866],</span>
285-
<span class="go"> [-0.79989, 0.53512, 0.46928, 0.26108, 1.6449, -1.2752]</span>
284+
<span class="go"> [1.8768, -0.095672, -0.57737, -0.65688, -1.6435, -1.5034],</span>
285+
<span class="go"> [-1.0135, 0.37397, -0.82459, -0.69565, 0.47782, 1.7299]</span>
286286
<span class="go">])</span>
287287
</pre></div>
288288
</div>
Binary file not shown.
Binary file not shown.
0 Bytes
Binary file not shown.
Binary file not shown.

0 commit comments

Comments
 (0)