Skip to content

Commit 9709c6c

Browse files
committed
Update documentation
1 parent 3e38a9f commit 9709c6c

56 files changed

Lines changed: 71 additions & 50 deletions

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_orient_SO2-1.pdf

0 Bytes
Binary file not shown.

2d_orient_SO2.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1292,13 +1292,14 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Permalink to th
12921292

12931293
<dl class="py method">
12941294
<dt class="sig sig-object py" id="spatialmath.pose2d.SO2.interp">
1295-
<span class="sig-name descname"><span class="pre">interp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">end</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">s</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#spatialmath.pose2d.SO2.interp" title="Permalink to this definition"></a></dt>
1295+
<span class="sig-name descname"><span class="pre">interp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">end</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">s</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shortest</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#spatialmath.pose2d.SO2.interp" title="Permalink to this definition"></a></dt>
12961296
<dd><p>Interpolate between poses (superclass method)</p>
12971297
<dl class="field-list simple">
12981298
<dt class="field-odd">Parameters</dt>
12991299
<dd class="field-odd"><ul class="simple">
13001300
<li><p><strong>end</strong> (same as <code class="docutils literal notranslate"><span class="pre">self</span></code>) – final pose</p></li>
13011301
<li><p><strong>s</strong> (<em>array_like</em><em> or </em><em>int</em>) – interpolation coefficient, range 0 to 1, or number of steps</p></li>
1302+
<li><p><strong>shortest</strong> (<em>bool</em><em>, </em><em>default to True</em>) – take the shortest path along the great circle for the rotation</p></li>
13021303
</ul>
13031304
</dd>
13041305
<dt class="field-even">Returns</dt>

2d_polygon-1.pdf

0 Bytes
Binary file not shown.

2d_polygon-2.pdf

0 Bytes
Binary file not shown.

2d_pose_SE2-1.pdf

0 Bytes
Binary file not shown.

2d_pose_SE2.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1447,13 +1447,14 @@ <h1>SE(2) matrix<a class="headerlink" href="#se-2-matrix" title="Permalink to th
14471447

14481448
<dl class="py method">
14491449
<dt class="sig sig-object py" id="spatialmath.pose2d.SE2.interp">
1450-
<span class="sig-name descname"><span class="pre">interp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">end</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">s</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#spatialmath.pose2d.SE2.interp" title="Permalink to this definition"></a></dt>
1450+
<span class="sig-name descname"><span class="pre">interp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">end</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">s</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shortest</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#spatialmath.pose2d.SE2.interp" title="Permalink to this definition"></a></dt>
14511451
<dd><p>Interpolate between poses (superclass method)</p>
14521452
<dl class="field-list simple">
14531453
<dt class="field-odd">Parameters</dt>
14541454
<dd class="field-odd"><ul class="simple">
14551455
<li><p><strong>end</strong> (same as <code class="docutils literal notranslate"><span class="pre">self</span></code>) – final pose</p></li>
14561456
<li><p><strong>s</strong> (<em>array_like</em><em> or </em><em>int</em>) – interpolation coefficient, range 0 to 1, or number of steps</p></li>
1457+
<li><p><strong>shortest</strong> (<em>bool</em><em>, </em><em>default to True</em>) – take the shortest path along the great circle for the rotation</p></li>
14571458
</ul>
14581459
</dd>
14591460
<dt class="field-even">Returns</dt>

2d_pose_twist.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -701,11 +701,11 @@ <h1>se(2) twist<a class="headerlink" href="#se-2-twist" title="Permalink to this
701701
<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="nn">spatialmath</span> <span class="kn">import</span> <span class="n">Twist3</span>
702702
<span class="gp">&gt;&gt;&gt; </span><span class="n">S</span> <span class="o">=</span> <span class="n">Twist3</span><span class="p">(</span><span class="n">SE3</span><span class="o">.</span><span class="n">Rand</span><span class="p">())</span>
703703
<span class="gp">&gt;&gt;&gt; </span><span class="n">S</span>
704-
<span class="go">Twist3([-0.0096108, 0.13661, 1.2874, -1.8586, -1.2044, -0.043502])</span>
704+
<span class="go">Twist3([-0.72372, 0.15896, 1.1698, 1.5402, 0.74391, 1.3487])</span>
705705
<span class="gp">&gt;&gt;&gt; </span><span class="n">S</span><span class="o">.</span><span class="n">inv</span><span class="p">()</span>
706-
<span class="go">Twist3([0.0096108, -0.13661, -1.2874, 1.8586, 1.2044, 0.043502])</span>
706+
<span class="go">Twist3([0.72372, -0.15896, -1.1698, -1.5402, -0.74391, -1.3487])</span>
707707
<span class="gp">&gt;&gt;&gt; </span><span class="n">S</span> <span class="o">*</span> <span class="n">S</span><span class="o">.</span><span class="n">inv</span><span class="p">()</span>
708-
<span class="go">Twist3([-5.5511e-17, -1.1102e-16, -3.8858e-16, 0, 0, 0])</span>
708+
<span class="go">Twist3([-3.4001e-16, 0, 4.4409e-16, 0, 2.6021e-17, 0])</span>
709709
</pre></div>
710710
</div>
711711
</dd></dl>

3d_orient_SO3-1.pdf

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)