Skip to content

Commit 0aa5068

Browse files
committed
Update documentation
1 parent b30da72 commit 0aa5068

57 files changed

Lines changed: 1050 additions & 977 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_ellipse.html‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ <h1>2D ellipse<a class="headerlink" href="#d-ellipse" title="Link to this headin
233233
<span class="gp">&gt;&gt;&gt; </span><span class="n">Ellipse</span><span class="p">(</span><span class="n">radii</span><span class="o">=</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">),</span> <span class="n">theta</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span>
234234
<span class="go">Ellipse(radii=[1.+0.j 2.-0.j], centre=(0, 0), theta=0.0)</span>
235235
<span class="gp">&gt;&gt;&gt; </span><span class="n">Ellipse</span><span class="p">(</span><span class="n">E</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">]]))</span>
236-
<span class="go">Ellipse(radii=[1.61803399-0.j 0.61803399+0.j], centre=(0, 0), theta=1.0172219678978514)</span>
236+
<span class="go">Ellipse(radii=[1.618-0.j 0.618+0.j], centre=(0, 0), theta=1.0172219678978514)</span>
237237
</pre></div>
238238
</div>
239239
</dd></dl>
@@ -335,8 +335,8 @@ <h1>2D ellipse<a class="headerlink" href="#d-ellipse" title="Link to this headin
335335
<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">Ellipse</span>
336336
<span class="gp">&gt;&gt;&gt; </span><span class="n">e</span> <span class="o">=</span> <span class="n">Ellipse</span><span class="p">(</span><span class="n">radii</span><span class="o">=</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">),</span> <span class="n">centre</span><span class="o">=</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span><span class="mi">4</span><span class="p">),</span> <span class="n">theta</span><span class="o">=</span><span class="mf">0.5</span><span class="p">)</span>
337337
<span class="gp">&gt;&gt;&gt; </span><span class="n">e</span><span class="o">.</span><span class="n">points</span><span class="p">()[:,:</span><span class="mi">5</span><span class="p">]</span> <span class="c1"># first 5 points</span>
338-
<span class="go">array([[4.22984885, 4.03964134, 3.7476665 , 3.38250485, 2.97990096],</span>
339-
<span class="go"> [3.57926451, 4.14686356, 4.70008658, 5.18478025, 5.55349937]])</span>
338+
<span class="go">array([[4.2298, 4.0396, 3.7477, 3.3825, 2.9799],</span>
339+
<span class="go"> [3.5793, 4.1469, 4.7001, 5.1848, 5.5535]])</span>
340340
</pre></div>
341341
</div>
342342
<dl class="field-list simple">
@@ -402,8 +402,8 @@ <h1>2D ellipse<a class="headerlink" href="#d-ellipse" title="Link to this headin
402402
<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">Ellipse</span>
403403
<span class="gp">&gt;&gt;&gt; </span><span class="n">e</span> <span class="o">=</span> <span class="n">Ellipse</span><span class="p">(</span><span class="n">radii</span><span class="o">=</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">),</span> <span class="n">centre</span><span class="o">=</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span><span class="mi">4</span><span class="p">),</span> <span class="n">theta</span><span class="o">=</span><span class="mf">0.5</span><span class="p">)</span>
404404
<span class="gp">&gt;&gt;&gt; </span><span class="n">e</span><span class="o">.</span><span class="n">E</span>
405-
<span class="go">array([[0.82761336, 0.31555162],</span>
406-
<span class="go"> [0.31555162, 0.42238664]])</span>
405+
<span class="go">array([[0.8276, 0.3156],</span>
406+
<span class="go"> [0.3156, 0.4224]])</span>
407407
</pre></div>
408408
</div>
409409
</dd></dl>
@@ -475,8 +475,7 @@ <h1>2D ellipse<a class="headerlink" href="#d-ellipse" title="Link to this headin
475475
<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">Ellipse</span>
476476
<span class="gp">&gt;&gt;&gt; </span><span class="n">e</span> <span class="o">=</span> <span class="n">Ellipse</span><span class="p">(</span><span class="n">radii</span><span class="o">=</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">),</span> <span class="n">centre</span><span class="o">=</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span><span class="mi">4</span><span class="p">),</span> <span class="n">theta</span><span class="o">=</span><span class="mf">0.5</span><span class="p">)</span>
477477
<span class="gp">&gt;&gt;&gt; </span><span class="n">e</span><span class="o">.</span><span class="n">polynomial</span>
478-
<span class="go">array([ 0.82761336, 0.42238664, 0.63110324, -7.49009314, -5.2724028 ,</span>
479-
<span class="go"> 21.77994531])</span>
478+
<span class="go">array([ 0.8276, 0.4224, 0.6311, -7.4901, -5.2724, 21.7799])</span>
480479
</pre></div>
481480
</div>
482481
<dl class="field-list simple">

‎2d_orient_SO2.html‎

Lines changed: 48 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -675,20 +675,20 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Link to this he
675675
<p>Example:</p>
676676
<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>
677677
<span class="gp">&gt;&gt;&gt; </span><span class="n">SE3</span><span class="o">.</span><span class="n">Rx</span><span class="p">(</span><span class="mf">0.1</span><span class="p">)</span> <span class="o">**</span> <span class="mi">2</span>
678-
<span class="go">SE3(array([[ 1. , 0. , 0. , 0. ],</span>
679-
<span class="go"> [ 0. , 0.98006658, -0.19866933, 0. ],</span>
680-
<span class="go"> [ 0. , 0.19866933, 0.98006658, 0. ],</span>
681-
<span class="go"> [ 0. , 0. , 0. , 1. ]]))</span>
678+
<span class="go">SE3(array([[ 1. , 0. , 0. , 0. ],</span>
679+
<span class="go"> [ 0. , 0.9801, -0.1987, 0. ],</span>
680+
<span class="go"> [ 0. , 0.1987, 0.9801, 0. ],</span>
681+
<span class="go"> [ 0. , 0. , 0. , 1. ]]))</span>
682682
<span class="gp">&gt;&gt;&gt; </span><span class="n">SE3</span><span class="o">.</span><span class="n">Rx</span><span class="p">([</span><span class="mi">0</span><span class="p">,</span> <span class="mf">0.1</span><span class="p">])</span> <span class="o">**</span> <span class="mi">2</span>
683683
<span class="go">SE3([</span>
684684
<span class="go">array([[1., 0., 0., 0.],</span>
685685
<span class="go"> [0., 1., 0., 0.],</span>
686686
<span class="go"> [0., 0., 1., 0.],</span>
687687
<span class="go"> [0., 0., 0., 1.]]),</span>
688-
<span class="go">array([[ 1. , 0. , 0. , 0. ],</span>
689-
<span class="go"> [ 0. , 0.98006658, -0.19866933, 0. ],</span>
690-
<span class="go"> [ 0. , 0.19866933, 0.98006658, 0. ],</span>
691-
<span class="go"> [ 0. , 0. , 0. , 1. ]]) ])</span>
688+
<span class="go">array([[ 1. , 0. , 0. , 0. ],</span>
689+
<span class="go"> [ 0. , 0.9801, -0.1987, 0. ],</span>
690+
<span class="go"> [ 0. , 0.1987, 0.9801, 0. ],</span>
691+
<span class="go"> [ 0. , 0. , 0. , 1. ]]) ])</span>
692692
</pre></div>
693693
</div>
694694
</dd></dl>
@@ -1118,11 +1118,11 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Link to this he
11181118
<span class="gp">&gt;&gt;&gt; </span><span class="n">R</span> <span class="o">=</span> <span class="n">SO2</span><span class="p">(</span><span class="mf">0.5</span><span class="p">)</span>
11191119
<span class="gp">&gt;&gt;&gt; </span><span class="n">A</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([[</span><span class="mi">10</span><span class="p">,</span> <span class="mi">0</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>
11201120
<span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">R</span> <span class="o">*</span> <span class="n">A</span> <span class="o">*</span> <span class="n">R</span><span class="o">.</span><span class="n">inv</span><span class="p">())</span>
1121-
<span class="go">[[7.93136038 3.78661943]</span>
1122-
<span class="go"> [3.78661943 3.06863962]]</span>
1121+
<span class="go">[[7.9314 3.7866]</span>
1122+
<span class="go"> [3.7866 3.0686]]</span>
11231123
<span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">R</span><span class="o">.</span><span class="n">conjugation</span><span class="p">(</span><span class="n">A</span><span class="p">))</span>
1124-
<span class="go">[[7.93136038 3.78661943]</span>
1125-
<span class="go"> [3.78661943 3.06863962]]</span>
1124+
<span class="go">[[7.9314 3.7866]</span>
1125+
<span class="go"> [3.7866 3.0686]]</span>
11261126
</pre></div>
11271127
</div>
11281128
</dd></dl>
@@ -1251,33 +1251,36 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Link to this he
12511251
<li><p><code class="docutils literal notranslate"><span class="pre">X.interp(Y,</span> <span class="pre">N)</span></code> interpolates pose between X and Y in <code class="docutils literal notranslate"><span class="pre">N</span></code> steps.</p></li>
12521252
</ul>
12531253
<p>Example:</p>
1254-
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gt">Traceback (most recent call last):</span>
1255-
File <span class="nb">"&lt;input&gt;"</span>, line <span class="m">1</span>, in <span class="n">&lt;module&gt;</span>
1256-
<span class="gr">NameError</span>: <span class="n">name 'SE3' is not defined</span>
1257-
<span class="gt">Traceback (most recent call last):</span>
1258-
File <span class="nb">"&lt;input&gt;"</span>, line <span class="m">1</span>, in <span class="n">&lt;module&gt;</span>
1259-
<span class="gr">NameError</span>: <span class="n">name 'SE3' is not defined</span>
1260-
<span class="gt">Traceback (most recent call last):</span>
1261-
File <span class="nb">"&lt;input&gt;"</span>, line <span class="m">1</span>, in <span class="n">&lt;module&gt;</span>
1262-
<span class="gr">NameError</span>: <span class="n">name 'x' is not defined</span>
1263-
<span class="gt">Traceback (most recent call last):</span>
1264-
File <span class="nb">"&lt;input&gt;"</span>, line <span class="m">1</span>, in <span class="n">&lt;module&gt;</span>
1265-
<span class="gr">NameError</span>: <span class="n">name 'x' is not defined</span>
1266-
<span class="gt">Traceback (most recent call last):</span>
1267-
File <span class="nb">"&lt;input&gt;"</span>, line <span class="m">1</span>, in <span class="n">&lt;module&gt;</span>
1268-
<span class="gr">NameError</span>: <span class="n">name 'x' is not defined</span>
1269-
<span class="gt">Traceback (most recent call last):</span>
1270-
File <span class="nb">"&lt;input&gt;"</span>, line <span class="m">1</span>, in <span class="n">&lt;module&gt;</span>
1271-
<span class="gr">NameError</span>: <span class="n">name 'x' is not defined</span>
1272-
<span class="gt">Traceback (most recent call last):</span>
1273-
File <span class="nb">"&lt;input&gt;"</span>, line <span class="m">1</span>, in <span class="n">&lt;module&gt;</span>
1274-
<span class="gr">NameError</span>: <span class="n">name 'z' is not defined</span>
1275-
<span class="gt">Traceback (most recent call last):</span>
1276-
File <span class="nb">"&lt;input&gt;"</span>, line <span class="m">1</span>, in <span class="n">&lt;module&gt;</span>
1277-
<span class="gr">NameError</span>: <span class="n">name 'z' is not defined</span>
1278-
<span class="gt">Traceback (most recent call last):</span>
1279-
File <span class="nb">"&lt;input&gt;"</span>, line <span class="m">1</span>, in <span class="n">&lt;module&gt;</span>
1280-
<span class="gr">NameError</span>: <span class="n">name 'z' is not defined</span>
1254+
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">x</span> <span class="o">=</span> <span class="n">SE3</span><span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="o">-</span><span class="mi">2</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span> <span class="o">*</span> <span class="n">SE3</span><span class="o">.</span><span class="n">Rx</span><span class="p">(</span><span class="o">-</span><span class="mf">0.3</span><span class="p">)</span>
1255+
<span class="gp">&gt;&gt;&gt; </span><span class="n">y</span> <span class="o">=</span> <span class="n">SE3</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span> <span class="o">*</span> <span class="n">SE3</span><span class="o">.</span><span class="n">Rx</span><span class="p">(</span><span class="mf">0.3</span><span class="p">)</span>
1256+
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">interp</span><span class="p">(</span><span class="n">y</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span> <span class="c1"># this is x</span>
1257+
<span class="go">SE3(array([[ 1. , 0. , 0. , -1. ],</span>
1258+
<span class="go"> [ 0. , 0.9553, 0.2955, -2. ],</span>
1259+
<span class="go"> [ 0. , -0.2955, 0.9553, 0. ],</span>
1260+
<span class="go"> [ 0. , 0. , 0. , 1. ]]))</span>
1261+
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">interp</span><span class="p">(</span><span class="n">y</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> <span class="c1"># this is y</span>
1262+
<span class="go">SE3(array([[ 1. , 0. , 0. , 1. ],</span>
1263+
<span class="go"> [ 0. , 0.9553, -0.2955, 2. ],</span>
1264+
<span class="go"> [ 0. , 0.2955, 0.9553, 0. ],</span>
1265+
<span class="go"> [ 0. , 0. , 0. , 1. ]]))</span>
1266+
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">interp</span><span class="p">(</span><span class="n">y</span><span class="p">,</span> <span class="mf">0.5</span><span class="p">)</span> <span class="c1"># this is in between</span>
1267+
<span class="go">SE3(array([[1., 0., 0., 0.],</span>
1268+
<span class="go"> [0., 1., 0., 0.],</span>
1269+
<span class="go"> [0., 0., 1., 0.],</span>
1270+
<span class="go"> [0., 0., 0., 1.]]))</span>
1271+
<span class="gp">&gt;&gt;&gt; </span><span class="n">z</span> <span class="o">=</span> <span class="n">x</span><span class="o">.</span><span class="n">interp</span><span class="p">(</span><span class="n">y</span><span class="p">,</span> <span class="mi">11</span><span class="p">)</span> <span class="c1"># in 11 steps</span>
1272+
<span class="gp">&gt;&gt;&gt; </span><span class="nb">len</span><span class="p">(</span><span class="n">z</span><span class="p">)</span>
1273+
<span class="go">11</span>
1274+
<span class="gp">&gt;&gt;&gt; </span><span class="n">z</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="c1"># this is x</span>
1275+
<span class="go">SE3(array([[ 1. , 0. , 0. , -1. ],</span>
1276+
<span class="go"> [ 0. , 0.9553, 0.2955, -2. ],</span>
1277+
<span class="go"> [ 0. , -0.2955, 0.9553, 0. ],</span>
1278+
<span class="go"> [ 0. , 0. , 0. , 1. ]]))</span>
1279+
<span class="gp">&gt;&gt;&gt; </span><span class="n">z</span><span class="p">[</span><span class="mi">5</span><span class="p">]</span> <span class="c1"># this is in between</span>
1280+
<span class="go">SE3(array([[1., 0., 0., 0.],</span>
1281+
<span class="go"> [0., 1., 0., 0.],</span>
1282+
<span class="go"> [0., 0., 1., 0.],</span>
1283+
<span class="go"> [0., 0., 0., 1.]]))</span>
12811284
</pre></div>
12821285
</div>
12831286
<div class="admonition note">
@@ -1703,15 +1706,13 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Link to this he
17031706
<span class="go"> 1 0 0 0 </span>
17041707
<span class="go"> 0 1 0 0 </span>
17051708
<span class="go"> 0 0 1 0 </span>
1706-
<span class="go"> 0 0 0 1 </span>
1707-
1709+
<span class="go"> 0 0 0 1</span>
17081710
<span class="gp">&gt;&gt;&gt; </span><span class="n">SE3</span><span class="p">()</span><span class="o">.</span><span class="n">print</span><span class="p">(</span><span class="s2">"pose is:"</span><span class="p">)</span>
17091711
<span class="go">pose is:</span>
17101712
<span class="go"> 1 0 0 0 </span>
17111713
<span class="go"> 0 1 0 0 </span>
17121714
<span class="go"> 0 0 1 0 </span>
1713-
<span class="go"> 0 0 0 1 </span>
1714-
1715+
<span class="go"> 0 0 0 1</span>
17151716
</pre></div>
17161717
</div>
17171718
<dl class="field-list simple">
@@ -1830,10 +1831,10 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Link to this he
18301831
<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>
18311832
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span> <span class="o">=</span> <span class="n">SE3</span><span class="o">.</span><span class="n">Rx</span><span class="p">([</span><span class="mi">0</span><span class="p">,</span> <span class="mf">0.1</span><span class="p">,</span> <span class="mf">0.2</span><span class="p">,</span> <span class="mf">0.3</span><span class="p">])</span>
18321833
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">prod</span><span class="p">()</span>
1833-
<span class="go">SE3(array([[ 1. , 0. , 0. , 0. ],</span>
1834-
<span class="go"> [ 0. , 0.82533561, -0.56464247, 0. ],</span>
1835-
<span class="go"> [ 0. , 0.56464247, 0.82533561, 0. ],</span>
1836-
<span class="go"> [ 0. , 0. , 0. , 1. ]]))</span>
1834+
<span class="go">SE3(array([[ 1. , 0. , 0. , 0. ],</span>
1835+
<span class="go"> [ 0. , 0.8253, -0.5646, 0. ],</span>
1836+
<span class="go"> [ 0. , 0.5646, 0.8253, 0. ],</span>
1837+
<span class="go"> [ 0. , 0. , 0. , 1. ]]))</span>
18371838
</pre></div>
18381839
</div>
18391840
<div class="admonition note">

0 commit comments

Comments
 (0)