Skip to content

Commit

Permalink
Regenerate docs from 7475f1d6f4df5c8dc0db6b46d49455af66cc372b
Browse files Browse the repository at this point in the history
  • Loading branch information
@bradley-solliday-skydio
bradley-solliday-skydio committed Feb 27, 2024
1 parent a28177c commit b1bb89b
Show file tree
Hide file tree
Showing 97 changed files with 1,285 additions and 1,037 deletions.
41 changes: 21 additions & 20 deletions _modules/setup.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _modules/sym/pose2.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -792,7 +792,7 @@ <h1>Source code for sym.pose2</h1><div class="highlight"><pre>
<span class="c1"># --------------------------------------------------------------------------</span>

<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">R</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">t</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="c1"># type: (Rot2, T.Union[T.Sequence[float], numpy.ndarray]) -&gt; None</span>
<span class="c1"># type: (T.Optional[Rot2], T.Union[T.Sequence[float], numpy.ndarray, None]) -&gt; None</span>
<span class="n">rotation</span> <span class="o">=</span> <span class="n">R</span> <span class="k">if</span> <span class="n">R</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">Rot2</span><span class="p">()</span>
<span class="k">if</span> <span class="n">t</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">t</span> <span class="o">=</span> <span class="p">[</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">]</span>
Expand Down
2 changes: 1 addition & 1 deletion _modules/sym/pose3.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -792,7 +792,7 @@ <h1>Source code for sym.pose3</h1><div class="highlight"><pre>
<span class="c1"># --------------------------------------------------------------------------</span>

<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">R</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">t</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="c1"># type: (Rot3, T.Union[T.Sequence[float], numpy.ndarray]) -&gt; None</span>
<span class="c1"># type: (T.Optional[Rot3], T.Union[T.Sequence[float], numpy.ndarray, None]) -&gt; None</span>
<span class="n">rotation</span> <span class="o">=</span> <span class="n">R</span> <span class="k">if</span> <span class="n">R</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">Rot3</span><span class="p">()</span>
<span class="k">if</span> <span class="n">t</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">t</span> <span class="o">=</span> <span class="p">[</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">]</span>
Expand Down
2 changes: 1 addition & 1 deletion _modules/sym/rot2.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -770,7 +770,7 @@ <h1>Source code for sym.rot2</h1><div class="highlight"><pre>
<span class="c1"># --------------------------------------------------------------------------</span>

<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">z</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="c1"># type: (T.Union[T.Sequence[float], numpy.ndarray]) -&gt; None</span>
<span class="c1"># type: (T.Union[T.Sequence[float], numpy.ndarray, None]) -&gt; None</span>
<span class="k">if</span> <span class="n">z</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">ops</span><span class="o">.</span><span class="n">GroupOps</span><span class="o">.</span><span class="n">identity</span><span class="p">()</span><span class="o">.</span><span class="n">data</span> <span class="c1"># type: T.List[float]</span>
<span class="k">else</span><span class="p">:</span>
Expand Down
15 changes: 9 additions & 6 deletions _modules/sym/rot3.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -770,7 +770,7 @@ <h1>Source code for sym.rot3</h1><div class="highlight"><pre>
<span class="c1"># --------------------------------------------------------------------------</span>

<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">q</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="c1"># type: (T.Union[T.Sequence[float], numpy.ndarray]) -&gt; None</span>
<span class="c1"># type: (T.Union[T.Sequence[float], numpy.ndarray, None]) -&gt; None</span>
<span class="k">if</span> <span class="n">q</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">ops</span><span class="o">.</span><span class="n">GroupOps</span><span class="o">.</span><span class="n">identity</span><span class="p">()</span><span class="o">.</span><span class="n">data</span> <span class="c1"># type: T.List[float]</span>
<span class="k">else</span><span class="p">:</span>
Expand Down Expand Up @@ -962,14 +962,17 @@ <h1>Source code for sym.rot3</h1><div class="highlight"><pre>
<div class="viewcode-block" id="Rot3.to_yaw_pitch_roll"><a class="viewcode-back" href="../../api-gen-py/sym.rot3.html#sym.rot3.Rot3.to_yaw_pitch_roll">[docs]</a> <span class="k">def</span> <span class="nf">to_yaw_pitch_roll</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># type: (Rot3) -&gt; numpy.ndarray</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> This function was autogenerated from a symbolic function. Do not modify by hand.</span>
<span class="sd"> Compute the yaw, pitch, and roll Euler angles in radians of this rotation</span>

<span class="sd"> Symbolic function: &lt;lambda&gt;</span>
<span class="sd"> Euler angles are subject to gimbal lock: https://en.wikipedia.org/wiki/Gimbal_lock</span>

<span class="sd"> Args:</span>
<span class="sd"> This means that when the pitch is close to +/- pi/2, the yaw and roll angles are not</span>
<span class="sd"> uniquely defined, so the returned values are not unique in this case.</span>

<span class="sd"> Outputs:</span>
<span class="sd"> res: Matrix31</span>
<span class="sd"> Returns:</span>
<span class="sd"> Scalar: Yaw angle [radians]</span>
<span class="sd"> Scalar: Pitch angle [radians]</span>
<span class="sd"> Scalar: Roll angle [radians]</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="c1"># Total ops: 27</span>
Expand Down
2 changes: 1 addition & 1 deletion _modules/sym/unit3.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -788,7 +788,7 @@ <h1>Source code for sym.unit3</h1><div class="highlight"><pre>
<span class="c1"># --------------------------------------------------------------------------</span>

<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">rot3</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="c1"># type: (Rot3) -&gt; None</span>
<span class="c1"># type: (T.Optional[Rot3]) -&gt; None</span>
<span class="k">if</span> <span class="n">rot3</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">ops</span><span class="o">.</span><span class="n">GroupOps</span><span class="o">.</span><span class="n">identity</span><span class="p">()</span><span class="o">.</span><span class="n">data</span> <span class="c1"># type: T.List[float]</span>
<span class="k">else</span><span class="p">:</span>
Expand Down
2 changes: 1 addition & 1 deletion _modules/symforce/benchmarks/run_benchmarks.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -940,7 +940,7 @@ <h1>Source code for symforce.benchmarks.run_benchmarks</h1><div class="highlight
<span class="nd">@argh</span><span class="o">.</span><span class="n">arg</span><span class="p">(</span>
<span class="s2">&quot;--out_dir&quot;</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Directory in which to put results (will be created if it does not exist)&quot;</span>
<span class="p">)</span>
<span class="k">def</span> <span class="nf">main</span><span class="p">(</span><span class="n">benchmark</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">out_dir</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;benchmark_outputs&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">def</span> <span class="nf">main</span><span class="p">(</span><span class="n">benchmark</span><span class="p">:</span> <span class="n">T</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">out_dir</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;benchmark_outputs&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">out_path</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">out_dir</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">out_path</span><span class="o">.</span><span class="n">is_dir</span><span class="p">():</span>
<span class="n">out_path</span><span class="o">.</span><span class="n">mkdir</span><span class="p">()</span>
Expand Down
4 changes: 3 additions & 1 deletion _modules/symforce/cam/camera.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -758,7 +758,9 @@ <h1>Source code for symforce.cam.camera</h1><div class="highlight"><pre>
<span class="c1"># Type that represents this or any subclasses</span>
<span class="n">CameraT</span> <span class="o">=</span> <span class="n">T</span><span class="o">.</span><span class="n">TypeVar</span><span class="p">(</span><span class="s2">&quot;CameraT&quot;</span><span class="p">,</span> <span class="n">bound</span><span class="o">=</span><span class="s2">&quot;Camera&quot;</span><span class="p">)</span>

<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">calibration</span><span class="p">:</span> <span class="n">CameraCal</span><span class="p">,</span> <span class="n">image_size</span><span class="p">:</span> <span class="n">T</span><span class="o">.</span><span class="n">Sequence</span><span class="p">[</span><span class="n">T</span><span class="o">.</span><span class="n">Scalar</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span> <span class="n">calibration</span><span class="p">:</span> <span class="n">CameraCal</span><span class="p">,</span> <span class="n">image_size</span><span class="p">:</span> <span class="n">T</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="n">T</span><span class="o">.</span><span class="n">Sequence</span><span class="p">[</span><span class="n">T</span><span class="o">.</span><span class="n">Scalar</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">calibration</span> <span class="o">=</span> <span class="n">calibration</span>

<span class="k">if</span> <span class="n">image_size</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
Expand Down
2 changes: 1 addition & 1 deletion _modules/symforce/cam/polynomial_camera_cal.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -777,7 +777,7 @@ <h1>Source code for symforce.cam.polynomial_camera_cal</h1><div class="highlight
<span class="n">focal_length</span><span class="p">:</span> <span class="n">T</span><span class="o">.</span><span class="n">Sequence</span><span class="p">[</span><span class="n">T</span><span class="o">.</span><span class="n">Scalar</span><span class="p">],</span>
<span class="n">principal_point</span><span class="p">:</span> <span class="n">T</span><span class="o">.</span><span class="n">Sequence</span><span class="p">[</span><span class="n">T</span><span class="o">.</span><span class="n">Scalar</span><span class="p">],</span>
<span class="n">distortion_coeffs</span><span class="p">:</span> <span class="n">T</span><span class="o">.</span><span class="n">Sequence</span><span class="p">[</span><span class="n">T</span><span class="o">.</span><span class="n">Scalar</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">),</span>
<span class="n">critical_undistorted_radius</span><span class="p">:</span> <span class="n">T</span><span class="o">.</span><span class="n">Scalar</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">critical_undistorted_radius</span><span class="p">:</span> <span class="n">T</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="n">T</span><span class="o">.</span><span class="n">Scalar</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">max_fov</span><span class="p">:</span> <span class="n">T</span><span class="o">.</span><span class="n">Scalar</span> <span class="o">=</span> <span class="n">DEFAULT_MAX_FOV</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
Expand Down
5 changes: 4 additions & 1 deletion _modules/symforce/cam/posed_camera.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -762,7 +762,10 @@ <h1>Source code for symforce.cam.posed_camera</h1><div class="highlight"><pre>
<span class="n">PosedCameraT</span> <span class="o">=</span> <span class="n">T</span><span class="o">.</span><span class="n">TypeVar</span><span class="p">(</span><span class="s2">&quot;PosedCameraT&quot;</span><span class="p">,</span> <span class="n">bound</span><span class="o">=</span><span class="s2">&quot;PosedCamera&quot;</span><span class="p">)</span>

<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span> <span class="n">pose</span><span class="p">:</span> <span class="n">geo</span><span class="o">.</span><span class="n">Pose3</span><span class="p">,</span> <span class="n">calibration</span><span class="p">:</span> <span class="n">CameraCal</span><span class="p">,</span> <span class="n">image_size</span><span class="p">:</span> <span class="n">T</span><span class="o">.</span><span class="n">Sequence</span><span class="p">[</span><span class="n">T</span><span class="o">.</span><span class="n">Scalar</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">pose</span><span class="p">:</span> <span class="n">geo</span><span class="o">.</span><span class="n">Pose3</span><span class="p">,</span>
<span class="n">calibration</span><span class="p">:</span> <span class="n">CameraCal</span><span class="p">,</span>
<span class="n">image_size</span><span class="p">:</span> <span class="n">T</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="n">T</span><span class="o">.</span><span class="n">Sequence</span><span class="p">[</span><span class="n">T</span><span class="o">.</span><span class="n">Scalar</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">calibration</span><span class="o">=</span><span class="n">calibration</span><span class="p">,</span> <span class="n">image_size</span><span class="o">=</span><span class="n">image_size</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pose</span> <span class="o">=</span> <span class="n">pose</span> <span class="c1"># global_T_cam</span>
Expand Down
2 changes: 1 addition & 1 deletion _modules/symforce/cam/spherical_camera_cal.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -793,7 +793,7 @@ <h1>Source code for symforce.cam.spherical_camera_cal</h1><div class="highlight"
<span class="n">focal_length</span><span class="p">:</span> <span class="n">T</span><span class="o">.</span><span class="n">Sequence</span><span class="p">[</span><span class="n">T</span><span class="o">.</span><span class="n">Scalar</span><span class="p">],</span>
<span class="n">principal_point</span><span class="p">:</span> <span class="n">T</span><span class="o">.</span><span class="n">Sequence</span><span class="p">[</span><span class="n">T</span><span class="o">.</span><span class="n">Scalar</span><span class="p">],</span>
<span class="n">distortion_coeffs</span><span class="p">:</span> <span class="n">T</span><span class="o">.</span><span class="n">Sequence</span><span class="p">[</span><span class="n">T</span><span class="o">.</span><span class="n">Scalar</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">),</span>
<span class="n">critical_theta</span><span class="p">:</span> <span class="n">T</span><span class="o">.</span><span class="n">Scalar</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">critical_theta</span><span class="p">:</span> <span class="n">T</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="n">T</span><span class="o">.</span><span class="n">Scalar</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">max_theta</span><span class="p">:</span> <span class="n">T</span><span class="o">.</span><span class="n">Scalar</span> <span class="o">=</span> <span class="n">math</span><span class="o">.</span><span class="n">pi</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
Expand Down
Loading

0 comments on commit b1bb89b

Please sign in to comment.