Skip to content

Commit d38e442

Browse files
committed
Update documentation
1 parent 0ae795a commit d38e442

109 files changed

Lines changed: 552 additions & 260 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-1.pdf‎

0 Bytes
Binary file not shown.

‎2d_ellipse-2.pdf‎

0 Bytes
Binary file not shown.

‎2d_ellipse.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ <h1>2D ellipse<a class="headerlink" href="#d-ellipse" title="Permalink to this h
131131
<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>
132132
<span class="go">(2, 20)</span>
133133
<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>
134-
<span class="go">Ellipse(radii=[1. 2.], centre=[3. 4.], theta=0.7853981633974324)</span>
134+
<span class="go">Ellipse(radii=[1. 2.], centre=[3. 4.], theta=0.7853981633974317)</span>
135135
</pre></div>
136136
</div>
137137
<dl class="field-list simple">
@@ -433,7 +433,7 @@ <h1>2D ellipse<a class="headerlink" href="#d-ellipse" title="Permalink to this h
433433

434434
<dl class="py property">
435435
<dt class="sig sig-object py" id="spatialmath.geom2d.Ellipse.centre">
436-
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">centre</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.24)"><span class="pre">numpy.ndarray</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v1.24)"><span class="pre">numpy.dtype</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://numpy.org/doc/stable/reference/arrays.scalars.html#numpy.floating" title="(in NumPy v1.24)"><span class="pre">numpy.floating</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#spatialmath.geom2d.Ellipse.centre" title="Permalink to this definition"></a></dt>
436+
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">centre</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.26)"><span class="pre">numpy.ndarray</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v1.26)"><span class="pre">numpy.dtype</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://numpy.org/doc/stable/reference/arrays.scalars.html#numpy.floating" title="(in NumPy v1.26)"><span class="pre">numpy.floating</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#spatialmath.geom2d.Ellipse.centre" title="Permalink to this definition"></a></dt>
437437
<dd><p>Return ellipse centre</p>
438438
<dl class="field-list simple">
439439
<dt class="field-odd">Returns</dt>
@@ -489,7 +489,7 @@ <h1>2D ellipse<a class="headerlink" href="#d-ellipse" title="Permalink to this h
489489

490490
<dl class="py property">
491491
<dt class="sig sig-object py" id="spatialmath.geom2d.Ellipse.radii">
492-
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">radii</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.24)"><span class="pre">numpy.ndarray</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v1.24)"><span class="pre">numpy.dtype</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://numpy.org/doc/stable/reference/arrays.scalars.html#numpy.floating" title="(in NumPy v1.24)"><span class="pre">numpy.floating</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#spatialmath.geom2d.Ellipse.radii" title="Permalink to this definition"></a></dt>
492+
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">radii</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.26)"><span class="pre">numpy.ndarray</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v1.26)"><span class="pre">numpy.dtype</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://numpy.org/doc/stable/reference/arrays.scalars.html#numpy.floating" title="(in NumPy v1.26)"><span class="pre">numpy.floating</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#spatialmath.geom2d.Ellipse.radii" title="Permalink to this definition"></a></dt>
493493
<dd><p>Return radii of the ellipse</p>
494494
<dl class="field-list simple">
495495
<dt class="field-odd">Returns</dt>
@@ -555,7 +555,7 @@ <h1>2D ellipse<a class="headerlink" href="#d-ellipse" title="Permalink to this h
555555

556556
<div role="contentinfo">
557557
<p>&#169; Copyright 2020-, Peter Corke..
558-
<span class="lastupdated">Last updated on 15-Jun-2023.
558+
<span class="lastupdated">Last updated on 20-Nov-2023.
559559
</span></p>
560560
</div>
561561

‎2d_line.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,7 @@ <h1>2D line<a class="headerlink" href="#d-line" title="Permalink to this headlin
295295

296296
<div role="contentinfo">
297297
<p>&#169; Copyright 2020-, Peter Corke..
298-
<span class="lastupdated">Last updated on 15-Jun-2023.
298+
<span class="lastupdated">Last updated on 20-Nov-2023.
299299
</span></p>
300300
</div>
301301

‎2d_linesegment.html‎

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

123123
<div role="contentinfo">
124124
<p>&#169; Copyright 2020-, Peter Corke..
125-
<span class="lastupdated">Last updated on 15-Jun-2023.
125+
<span class="lastupdated">Last updated on 20-Nov-2023.
126126
</span></p>
127127
</div>
128128

‎2d_orient_SO2-1.pdf‎

0 Bytes
Binary file not shown.

‎2d_orient_SO2.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1585,7 +1585,7 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Permalink to th
15851585
<dd><p>Test if matrix is valid SO(2)</p>
15861586
<dl class="field-list simple">
15871587
<dt class="field-odd">Parameters</dt>
1588-
<dd class="field-odd"><p><strong>x</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.24)"><em>numpy.ndarray</em></a>) – matrix to test</p>
1588+
<dd class="field-odd"><p><strong>x</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.26)"><em>numpy.ndarray</em></a>) – matrix to test</p>
15891589
</dd>
15901590
<dt class="field-even">Returns</dt>
15911591
<dd class="field-even"><p>True if the matrix is a valid element of SO(2), ie. it is a 2x2
@@ -1700,7 +1700,7 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Permalink to th
17001700
</ol>
17011701
<dl class="field-list simple">
17021702
<dt class="field-odd">Seealso</dt>
1703-
<dd class="field-odd"><p><a class="reference internal" href="func_3d.html#spatialmath.base.transforms3d.trnorm" title="spatialmath.base.transforms3d.trnorm"><code class="xref py py-func docutils literal notranslate"><span class="pre">trnorm()</span></code></a>, <code class="xref py py-func docutils literal notranslate"><span class="pre">trnorm2()</span></code></p>
1703+
<dd class="field-odd"><p><a class="reference internal" href="func_3d.html#spatialmath.base.transforms3d.trnorm" title="spatialmath.base.transforms3d.trnorm"><code class="xref py py-func docutils literal notranslate"><span class="pre">trnorm()</span></code></a>, <a class="reference internal" href="func_2d.html#spatialmath.base.transforms2d.trnorm2" title="spatialmath.base.transforms2d.trnorm2"><code class="xref py py-func docutils literal notranslate"><span class="pre">trnorm2()</span></code></a></p>
17041704
</dd>
17051705
</dl>
17061706
</dd></dl>
@@ -2166,7 +2166,7 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Permalink to th
21662166

21672167
<dl class="py property">
21682168
<dt class="sig sig-object py" id="spatialmath.pose2d.SO2.A">
2169-
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">A</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.24)"><span class="pre">numpy.ndarray</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v1.24)"><span class="pre">numpy.dtype</span></a><span class="p"><span class="pre">[</span></span><span class="pre">numpy.typing._generic_alias.ScalarType</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.24)"><span class="pre">numpy.ndarray</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v1.24)"><span class="pre">numpy.dtype</span></a><span class="p"><span class="pre">[</span></span><span class="pre">numpy.typing._generic_alias.ScalarType</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#spatialmath.pose2d.SO2.A" title="Permalink to this definition"></a></dt>
2169+
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">A</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.26)"><span class="pre">numpy.ndarray</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v1.26)"><span class="pre">numpy.dtype</span></a><span class="p"><span class="pre">[</span></span><span class="pre">numpy.typing._generic_alias.ScalarType</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.26)"><span class="pre">numpy.ndarray</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v1.26)"><span class="pre">numpy.dtype</span></a><span class="p"><span class="pre">[</span></span><span class="pre">numpy.typing._generic_alias.ScalarType</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#spatialmath.pose2d.SO2.A" title="Permalink to this definition"></a></dt>
21702170
<dd><p>Array value of an instance (BasePoseList superclass method)</p>
21712171
<dl class="field-list simple">
21722172
<dt class="field-odd">Returns</dt>
@@ -2220,7 +2220,7 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Permalink to th
22202220
<dd class="field-odd"><p>rotational component</p>
22212221
</dd>
22222222
<dt class="field-even">Return type</dt>
2223-
<dd class="field-even"><p><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.24)">numpy.ndarray</a>, shape=(2,2)</p>
2223+
<dd class="field-even"><p><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.26)">numpy.ndarray</a>, shape=(2,2)</p>
22242224
</dd>
22252225
</dl>
22262226
<p><code class="docutils literal notranslate"><span class="pre">x.R</span></code> returns the rotation matrix, when <cite>x</cite> is <cite>SO2</cite> or <cite>SE2</cite>. If <cite>len(x)</cite> is:</p>
@@ -2317,7 +2317,7 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Permalink to th
23172317

23182318
<div role="contentinfo">
23192319
<p>&#169; Copyright 2020-, Peter Corke..
2320-
<span class="lastupdated">Last updated on 15-Jun-2023.
2320+
<span class="lastupdated">Last updated on 20-Nov-2023.
23212321
</span></p>
23222322
</div>
23232323

‎2d_polygon-1.pdf‎

0 Bytes
Binary file not shown.

‎2d_polygon-2.pdf‎

0 Bytes
Binary file not shown.

‎2d_polygon.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -537,7 +537,7 @@ <h1>2D polgon<a class="headerlink" href="#d-polgon" title="Permalink to this hea
537537

538538
<div role="contentinfo">
539539
<p>&#169; Copyright 2020-, Peter Corke..
540-
<span class="lastupdated">Last updated on 15-Jun-2023.
540+
<span class="lastupdated">Last updated on 20-Nov-2023.
541541
</span></p>
542542
</div>
543543

0 commit comments

Comments
 (0)