Skip to content

Commit b320ec9

Browse files
committed
Update documentation
1 parent e22296d commit b320ec9

58 files changed

Lines changed: 551 additions & 131 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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ <h1>2D ellipse<a class="headerlink" href="#d-ellipse" title="Link to this headin
129129
<span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">perim</span><span class="o">.</span><span class="n">shape</span><span class="p">)</span>
130130
<span class="go">(2, 20)</span>
131131
<span class="gp">&gt;&gt;&gt; </span><span class="n">Ellipse</span><span class="o">.</span><span class="n">FromPerimeter</span><span class="p">(</span><span class="n">perim</span><span class="p">)</span>
132-
<span class="go">Ellipse(radii=[1.+0.j 2.-0.j], centre=[3. 4.], theta=0.785398163397435)</span>
132+
<span class="go">Ellipse(radii=[1.+0.j 2.-0.j], centre=[3. 4.], theta=0.7853981633974343)</span>
133133
</pre></div>
134134
</div>
135135
<dl class="field-list simple">

‎2d_orient_SO2.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1961,9 +1961,9 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Link to this he
19611961
<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="mf">0.2</span><span class="p">,</span> <span class="mf">0.3</span><span class="p">])</span>
19621962
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">strline</span><span class="p">()</span>
19631963
<span class="go">'t = 0, 0, 0; rpy/zyx = 11.5°, 0°, 0°t = 0, 0, 0; rpy/zyx = 17.2°, 0°, 0°'</span>
1964-
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">strline</span><span class="p">(</span><span class="s1">'angvec'</span><span class="p">)</span>
1964+
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">strline</span><span class="p">(</span><span class="n">orient</span><span class="o">=</span><span class="s2">"angvec"</span><span class="p">)</span>
19651965
<span class="go">'t = 0, 0, 0; angvec = (11.5° | 1, 0, 0)t = 0, 0, 0; angvec = (17.2° | 1, 0, 0)'</span>
1966-
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">strline</span><span class="p">(</span><span class="n">orient</span><span class="o">=</span><span class="s1">'angvec'</span><span class="p">,</span> <span class="n">fmt</span><span class="o">=</span><span class="s2">"</span><span class="si">{:.6f}</span><span class="s2">"</span><span class="p">)</span>
1966+
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">strline</span><span class="p">(</span><span class="n">orient</span><span class="o">=</span><span class="s2">"angvec"</span><span class="p">,</span> <span class="n">fmt</span><span class="o">=</span><span class="s2">"</span><span class="si">{:.6f}</span><span class="s2">"</span><span class="p">)</span>
19671967
<span class="go">'t = 0.000000, 0.000000, 0.000000; angvec = (11.459156° | 1.000000, 0.000000, 0.000000)t = 0.000000, 0.000000, 0.000000; angvec = (17.188734° | 1.000000, 0.000000, 0.000000)'</span>
19681968
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span> <span class="o">=</span> <span class="n">SE2</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="mf">0.3</span><span class="p">)</span>
19691969
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">strline</span><span class="p">()</span>

‎2d_pose_SE2.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2149,9 +2149,9 @@ <h1>SE(2) matrix<a class="headerlink" href="#se-2-matrix" title="Link to this he
21492149
<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="mf">0.2</span><span class="p">,</span> <span class="mf">0.3</span><span class="p">])</span>
21502150
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">strline</span><span class="p">()</span>
21512151
<span class="go">'t = 0, 0, 0; rpy/zyx = 11.5°, 0°, 0°t = 0, 0, 0; rpy/zyx = 17.2°, 0°, 0°'</span>
2152-
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">strline</span><span class="p">(</span><span class="s1">'angvec'</span><span class="p">)</span>
2152+
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">strline</span><span class="p">(</span><span class="n">orient</span><span class="o">=</span><span class="s2">"angvec"</span><span class="p">)</span>
21532153
<span class="go">'t = 0, 0, 0; angvec = (11.5° | 1, 0, 0)t = 0, 0, 0; angvec = (17.2° | 1, 0, 0)'</span>
2154-
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">strline</span><span class="p">(</span><span class="n">orient</span><span class="o">=</span><span class="s1">'angvec'</span><span class="p">,</span> <span class="n">fmt</span><span class="o">=</span><span class="s2">"</span><span class="si">{:.6f}</span><span class="s2">"</span><span class="p">)</span>
2154+
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">strline</span><span class="p">(</span><span class="n">orient</span><span class="o">=</span><span class="s2">"angvec"</span><span class="p">,</span> <span class="n">fmt</span><span class="o">=</span><span class="s2">"</span><span class="si">{:.6f}</span><span class="s2">"</span><span class="p">)</span>
21552155
<span class="go">'t = 0.000000, 0.000000, 0.000000; angvec = (11.459156° | 1.000000, 0.000000, 0.000000)t = 0.000000, 0.000000, 0.000000; angvec = (17.188734° | 1.000000, 0.000000, 0.000000)'</span>
21562156
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span> <span class="o">=</span> <span class="n">SE2</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="mf">0.3</span><span class="p">)</span>
21572157
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">strline</span><span class="p">()</span>

‎3d_orient_SO3.html‎

Lines changed: 5 additions & 5 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.31070142, -0.94804003, -0.068445 ],</span>
509-
<span class="go"> [-0.26848321, 0.15661038, -0.95046828],</span>
510-
<span class="go"> [ 0.91180118, -0.27693552, -0.3031919 ]]))</span>
508+
<span class="go">SO3(array([[ 0.2026146 , 0.60253077, 0.77194818],</span>
509+
<span class="go"> [-0.60187365, -0.54520401, 0.58352438],</span>
510+
<span class="go"> [ 0.77246064, -0.58284582, 0.2521811 ]]))</span>
511511
</pre></div>
512512
</div>
513513
<dl class="field-list simple">
@@ -2708,9 +2708,9 @@ <h1>SO(3) matrix<a class="headerlink" href="#so-3-matrix" title="Link to this he
27082708
<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="mf">0.2</span><span class="p">,</span> <span class="mf">0.3</span><span class="p">])</span>
27092709
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">strline</span><span class="p">()</span>
27102710
<span class="go">'t = 0, 0, 0; rpy/zyx = 11.5°, 0°, 0°t = 0, 0, 0; rpy/zyx = 17.2°, 0°, 0°'</span>
2711-
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">strline</span><span class="p">(</span><span class="s1">'angvec'</span><span class="p">)</span>
2711+
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">strline</span><span class="p">(</span><span class="n">orient</span><span class="o">=</span><span class="s2">"angvec"</span><span class="p">)</span>
27122712
<span class="go">'t = 0, 0, 0; angvec = (11.5° | 1, 0, 0)t = 0, 0, 0; angvec = (17.2° | 1, 0, 0)'</span>
2713-
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">strline</span><span class="p">(</span><span class="n">orient</span><span class="o">=</span><span class="s1">'angvec'</span><span class="p">,</span> <span class="n">fmt</span><span class="o">=</span><span class="s2">"</span><span class="si">{:.6f}</span><span class="s2">"</span><span class="p">)</span>
2713+
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">strline</span><span class="p">(</span><span class="n">orient</span><span class="o">=</span><span class="s2">"angvec"</span><span class="p">,</span> <span class="n">fmt</span><span class="o">=</span><span class="s2">"</span><span class="si">{:.6f}</span><span class="s2">"</span><span class="p">)</span>
27142714
<span class="go">'t = 0.000000, 0.000000, 0.000000; angvec = (11.459156° | 1.000000, 0.000000, 0.000000)t = 0.000000, 0.000000, 0.000000; angvec = (17.188734° | 1.000000, 0.000000, 0.000000)'</span>
27152715
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span> <span class="o">=</span> <span class="n">SE2</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="mf">0.3</span><span class="p">)</span>
27162716
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">strline</span><span class="p">()</span>

‎3d_orient_unitquaternion.html‎

Lines changed: 25 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.1120 &lt;&lt; -0.3674, -0.1185, -0.9156 &gt;&gt;</span>
470+
<span class="go"> 0.8242 &lt;&lt; -0.0386, 0.4429, -0.3508 &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.3740 &lt;&lt; -0.5409, -0.6186, -0.4300 &gt;&gt;</span>
473-
<span class="go"> 0.2517 &lt;&lt; -0.8002, 0.1498, -0.5233 &gt;&gt;</span>
474-
<span class="go"> 0.4328 &lt;&lt; -0.7524, 0.4960, 0.0221 &gt;&gt;</span>
472+
<span class="go"> 0.8858 &lt;&lt; -0.2009, 0.0229, -0.4178 &gt;&gt;</span>
473+
<span class="go"> 0.5208 &lt;&lt; -0.3056, -0.4514, 0.6570 &gt;&gt;</span>
474+
<span class="go"> 0.3350 &lt;&lt; 0.5145, 0.5718, 0.5441 &gt;&gt;</span>
475475
</pre></div>
476476
</div>
477477
<dl class="field-list simple">
@@ -2061,6 +2061,27 @@ <h1>Unit quaternion<a class="headerlink" href="#unit-quaternion" title="Link to
20612061
<p>where <code class="docutils literal notranslate"><span class="pre">X</span></code> is any of the SMTB classes.</p>
20622062
</dd></dl>
20632063

2064+
<dl class="py method">
2065+
<dt class="sig sig-object py" id="spatialmath.quaternion.UnitQuaternion.printline">
2066+
<span class="sig-name descname"><span class="pre">printline</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#spatialmath.quaternion.UnitQuaternion.printline" title="Link to this definition"></a></dt>
2067+
<dd><p>Print quaternion in compact single-line format (superclass method)</p>
2068+
<p>Example:</p>
2069+
<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">Quaternion</span><span class="p">,</span> <span class="n">UnitQuaternion</span>
2070+
<span class="gp">&gt;&gt;&gt; </span><span class="n">q</span> <span class="o">=</span> <span class="n">Quaternion</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">3</span><span class="p">,</span><span class="mi">4</span><span class="p">])</span>
2071+
<span class="gp">&gt;&gt;&gt; </span><span class="n">q</span><span class="o">.</span><span class="n">printline</span><span class="p">()</span>
2072+
<span class="go"> 1.0000 &lt; 2.0000, 3.0000, 4.0000 &gt;</span>
2073+
<span class="gp">&gt;&gt;&gt; </span><span class="n">q</span> <span class="o">=</span> <span class="n">UnitQuaternion</span><span class="o">.</span><span class="n">Rx</span><span class="p">(</span><span class="mf">0.3</span><span class="p">)</span>
2074+
<span class="gp">&gt;&gt;&gt; </span><span class="n">q</span><span class="o">.</span><span class="n">printline</span><span class="p">()</span>
2075+
<span class="go"> 0.9888 &lt;&lt; 0.1494, 0.0000, 0.0000 &gt;&gt;</span>
2076+
<span class="gp">&gt;&gt;&gt; </span><span class="n">q</span> <span class="o">=</span> <span class="n">UnitQuaternion</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="mf">0.2</span><span class="p">,</span> <span class="mf">0.3</span><span class="p">])</span>
2077+
<span class="gp">&gt;&gt;&gt; </span><span class="n">q</span><span class="o">.</span><span class="n">printline</span><span class="p">()</span>
2078+
<span class="go"> 0.9988 &lt;&lt; 0.0500, 0.0000, 0.0000 &gt;&gt;</span>
2079+
<span class="go"> 0.9950 &lt;&lt; 0.0998, 0.0000, 0.0000 &gt;&gt;</span>
2080+
<span class="go"> 0.9888 &lt;&lt; 0.1494, 0.0000, 0.0000 &gt;&gt;</span>
2081+
</pre></div>
2082+
</div>
2083+
</dd></dl>
2084+
20642085
<dl class="py method">
20652086
<dt class="sig sig-object py" id="spatialmath.quaternion.UnitQuaternion.reverse">
20662087
<span class="sig-name descname"><span class="pre">reverse</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#spatialmath.quaternion.UnitQuaternion.reverse" title="Link to this definition"></a></dt>

‎3d_pose_SE3.html‎

Lines changed: 8 additions & 8 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.89891087, 0.4194106 , -0.12670433, -0.18823248],</span>
610-
<span class="go"> [-0.02791534, -0.23377841, -0.97188908, -0.05293757],</span>
611-
<span class="go"> [-0.43724132, 0.87717866, -0.19843797, -0.4543993 ],</span>
609+
<span class="go">array([[ 0.3392705 , 0.75571912, -0.56016438, 0.67183925],</span>
610+
<span class="go"> [-0.43647342, -0.40103643, -0.80539477, -0.13352531],</span>
611+
<span class="go"> [-0.83329855, 0.51774355, 0.19379148, 0.6626964 ],</span>
612612
<span class="go"> [ 0. , 0. , 0. , 1. ]]),</span>
613-
<span class="go">array([[-0.24290276, -0.93384413, -0.2625517 , -0.34687182],</span>
614-
<span class="go"> [-0.4710408 , -0.12305909, 0.87348556, 0.2926366 ],</span>
615-
<span class="go"> [-0.84800873, 0.33584462, -0.4099873 , -0.40876947],</span>
613+
<span class="go">array([[-0.5293599 , 0.18233681, 0.8285719 , -0.01495776],</span>
614+
<span class="go"> [-0.83221571, 0.07823569, -0.54890453, 0.01190558],</span>
615+
<span class="go"> [-0.16490939, -0.9801186 , 0.11032872, 0.76666983],</span>
616616
<span class="go"> [ 0. , 0. , 0. , 1. ]]) ])</span>
617617
</pre></div>
618618
</div>
@@ -3089,9 +3089,9 @@ <h1>SE(3) matrix<a class="headerlink" href="#se-3-matrix" title="Link to this he
30893089
<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="mf">0.2</span><span class="p">,</span> <span class="mf">0.3</span><span class="p">])</span>
30903090
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">strline</span><span class="p">()</span>
30913091
<span class="go">'t = 0, 0, 0; rpy/zyx = 11.5°, 0°, 0°t = 0, 0, 0; rpy/zyx = 17.2°, 0°, 0°'</span>
3092-
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">strline</span><span class="p">(</span><span class="s1">'angvec'</span><span class="p">)</span>
3092+
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">strline</span><span class="p">(</span><span class="n">orient</span><span class="o">=</span><span class="s2">"angvec"</span><span class="p">)</span>
30933093
<span class="go">'t = 0, 0, 0; angvec = (11.5° | 1, 0, 0)t = 0, 0, 0; angvec = (17.2° | 1, 0, 0)'</span>
3094-
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">strline</span><span class="p">(</span><span class="n">orient</span><span class="o">=</span><span class="s1">'angvec'</span><span class="p">,</span> <span class="n">fmt</span><span class="o">=</span><span class="s2">"</span><span class="si">{:.6f}</span><span class="s2">"</span><span class="p">)</span>
3094+
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">strline</span><span class="p">(</span><span class="n">orient</span><span class="o">=</span><span class="s2">"angvec"</span><span class="p">,</span> <span class="n">fmt</span><span class="o">=</span><span class="s2">"</span><span class="si">{:.6f}</span><span class="s2">"</span><span class="p">)</span>
30953095
<span class="go">'t = 0.000000, 0.000000, 0.000000; angvec = (11.459156° | 1.000000, 0.000000, 0.000000)t = 0.000000, 0.000000, 0.000000; angvec = (17.188734° | 1.000000, 0.000000, 0.000000)'</span>
30963096
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span> <span class="o">=</span> <span class="n">SE2</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="mf">0.3</span><span class="p">)</span>
30973097
<span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">strline</span><span class="p">()</span>

0 commit comments

Comments
 (0)