Skip to content

Commit a061643

Browse files
committed
Update documentation
1 parent b2b4f49 commit a061643

102 files changed

Lines changed: 1222 additions & 1149 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: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ <h1>2D ellipse<a class="headerlink" href="#d-ellipse" title="Link to this headin
118118
<dd class="field-even"><p>an ellipse instance</p>
119119
</dd>
120120
<dt class="field-odd">Return type<span class="colon">:</span></dt>
121-
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
121+
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Self</span></code></span></p>
122122
</dd>
123123
</dl>
124124
<p>Example:</p>
@@ -151,7 +151,7 @@ <h1>2D ellipse<a class="headerlink" href="#d-ellipse" title="Link to this headin
151151
<dd class="field-even"><p>an ellipse instance</p>
152152
</dd>
153153
<dt class="field-odd">Return type<span class="colon">:</span></dt>
154-
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
154+
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Self</span></code></span></p>
155155
</dd>
156156
</dl>
157157
<p>Computes the ellipse that has the same inertia as the set of points.</p>
@@ -177,7 +177,7 @@ <h1>2D ellipse<a class="headerlink" href="#d-ellipse" title="Link to this headin
177177
<dd class="field-even"><p>an ellipse instance</p>
178178
</dd>
179179
<dt class="field-odd">Return type<span class="colon">:</span></dt>
180-
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
180+
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Self</span></code></span></p>
181181
</dd>
182182
</dl>
183183
<p>An ellipse can be specified by a polynomial <span class="math notranslate nohighlight">\(\vec{e} \in \mathbb{R}^6\)</span></p>
@@ -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">
@@ -554,7 +553,7 @@ <h1>2D ellipse<a class="headerlink" href="#d-ellipse" title="Link to this headin
554553

555554
<div role="contentinfo">
556555
<p>&#169; Copyright 2020-, Peter Corke..
557-
<span class="lastupdated">Last updated on 13-Oct-2026.
556+
<span class="lastupdated">Last updated on 16-Oct-2026.
558557
</span></p>
559558
</div>
560559

‎2d_line.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ <h1>2D line<a class="headerlink" href="#d-line" title="Link to this heading">
125125
<dd class="field-even"><p>a 2D line</p>
126126
</dd>
127127
<dt class="field-odd">Return type<span class="colon">:</span></dt>
128-
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
128+
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Self</span></code></span></p>
129129
</dd>
130130
</dl>
131131
<p>Creates a line from the parameters of the general line <span class="math notranslate nohighlight">\(y = mx + c\)</span>.</p>
@@ -147,7 +147,7 @@ <h1>2D line<a class="headerlink" href="#d-line" title="Link to this heading">
147147
</ul>
148148
</dd>
149149
<dt class="field-even">Return type<span class="colon">:</span></dt>
150-
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
150+
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Self</span></code></span></p>
151151
</dd>
152152
</dl>
153153
<p>The points can be given in Euclidean or homogeneous form.</p>
@@ -158,7 +158,7 @@ <h1>2D line<a class="headerlink" href="#d-line" title="Link to this heading">
158158
<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">TwoPoints</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">p1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p2</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/spatialmath/geom2d.html#Line2.TwoPoints"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#spatialmath.geom2d.Line2.TwoPoints" title="Link to this definition"></a></dt>
159159
<dd><dl class="field-list simple">
160160
<dt class="field-odd">Return type<span class="colon">:</span></dt>
161-
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
161+
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Self</span></code></span></p>
162162
</dd>
163163
</dl>
164164
</dd></dl>
@@ -298,7 +298,7 @@ <h1>2D line<a class="headerlink" href="#d-line" title="Link to this heading">
298298

299299
<div role="contentinfo">
300300
<p>&#169; Copyright 2020-, Peter Corke..
301-
<span class="lastupdated">Last updated on 13-Oct-2026.
301+
<span class="lastupdated">Last updated on 16-Oct-2026.
302302
</span></p>
303303
</div>
304304

‎2d_linesegment.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ <h1>2D line segment<a class="headerlink" href="#d-line-segment" title="Link to t
120120

121121
<div role="contentinfo">
122122
<p>&#169; Copyright 2020-, Peter Corke..
123-
<span class="lastupdated">Last updated on 13-Oct-2026.
123+
<span class="lastupdated">Last updated on 16-Oct-2026.
124124
</span></p>
125125
</div>
126126

0 commit comments

Comments
 (0)