Skip to content

Commit

Permalink
deploy: d0609c3
Browse files Browse the repository at this point in the history
  • Loading branch information
@qian-chu
qian-chu committed Oct 17, 2024
1 parent 6fdf1ec commit 9295bab
Show file tree
Hide file tree
Showing 7 changed files with 62 additions and 58 deletions.
19 changes: 6 additions & 13 deletions genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,6 @@ <h1 id="index">Index</h1>
| <a href="#L"><strong>L</strong></a>
| <a href="#M"><strong>M</strong></a>
| <a href="#N"><strong>N</strong></a>
| <a href="#O"><strong>O</strong></a>
| <a href="#P"><strong>P</strong></a>
| <a href="#R"><strong>R</strong></a>
| <a href="#S"><strong>S</strong></a>
Expand Down Expand Up @@ -558,18 +557,6 @@ <h2 id="N">N</h2>
</ul></td>
</tr></table>

<h2 id="O">O</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference/data.html#pyneon.video.overlay_scanpath_on_video">overlay_scanpath_on_video() (in module pyneon.video)</a>

<ul>
<li><a href="reference/recording.html#pyneon.NeonRecording.overlay_scanpath_on_video">(pyneon.NeonRecording method)</a>
</li>
</ul></li>
</ul></td>
</tr></table>

<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
Expand All @@ -583,6 +570,12 @@ <h2 id="P">P</h2>

<ul>
<li><a href="reference/data.html#pyneon.video.NeonVideo.plot_frame">(pyneon.video.NeonVideo method)</a>
</li>
</ul></li>
<li><a href="reference/vis.html#pyneon.vis.plot_scanpath_on_video">plot_scanpath_on_video() (in module pyneon.vis)</a>

<ul>
<li><a href="reference/recording.html#pyneon.NeonRecording.plot_scanpath_on_video">(pyneon.NeonRecording method)</a>
</li>
</ul></li>
<li>
Expand Down
Binary file modified objects.inv
View file
Binary file not shown.
31 changes: 10 additions & 21 deletions reference/data.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -816,31 +816,21 @@ <h2>Returns:<a class="headerlink" href="#returns" title="Link to this heading">#

<dl class="py function">
<dt class="sig sig-object py" id="pyneon.video.estimate_scanpath">
<span class="sig-prename descclassname"><span class="pre">pyneon.video.</span></span><span class="sig-name descname"><span class="pre">estimate_scanpath</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rec</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="recording.html#pyneon.NeonRecording" title="pyneon.NeonRecording"><span class="pre">NeonRecording</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">sync_gaze</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyneon.stream.NeonGaze" title="pyneon.stream.NeonGaze"><span class="pre">NeonGaze</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lk_params</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><span class="pre">dict</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.3)"><span class="pre">DataFrame</span></a></span></span><a class="headerlink" href="#pyneon.video.estimate_scanpath" title="Link to this definition">#</a></dt>
<dd><p>Map fixations to video frames.</p>
<span class="sig-prename descclassname"><span class="pre">pyneon.video.</span></span><span class="sig-name descname"><span class="pre">estimate_scanpath</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">video</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyneon.video.NeonVideo" title="pyneon.video.NeonVideo"><span class="pre">NeonVideo</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">sync_gaze</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyneon.stream.NeonGaze" title="pyneon.stream.NeonGaze"><span class="pre">NeonGaze</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">lk_params</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><span class="pre">dict</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.3)"><span class="pre">DataFrame</span></a></span></span><a class="headerlink" href="#pyneon.video.estimate_scanpath" title="Link to this definition">#</a></dt>
<dd><p>Map fixations to video frames using optical flow.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>rec</strong> (<a class="reference internal" href="recording.html#pyneon.NeonRecording" title="pyneon.NeonRecording"><em>NeonRecording</em></a>) – Recording object containing gaze and video data.</p></li>
<li><p><strong>lk_params</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><em>dict</em></a>) – Parameters for the Lucas-Kanade optical flow algorithm.</p></li>
<li><p><strong>video</strong> (<a class="reference internal" href="#pyneon.video.NeonVideo" title="pyneon.video.NeonVideo"><em>NeonVideo</em></a>) – Video object containing the frames.</p></li>
<li><p><strong>sync_gaze</strong> (<a class="reference internal" href="#pyneon.stream.NeonGaze" title="pyneon.stream.NeonGaze"><em>NeonGaze</em></a>) – Gaze data synchronized with the video frames.</p></li>
<li><p><strong>lk_params</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><em>dict</em></a><em>, </em><em>optional</em>) – Parameters for the Lucas-Kanade optical flow algorithm.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="pyneon.video.overlay_scanpath_on_video">
<span class="sig-prename descclassname"><span class="pre">pyneon.video.</span></span><span class="sig-name descname"><span class="pre">overlay_scanpath_on_video</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rec</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="recording.html#pyneon.NeonRecording" title="pyneon.NeonRecording"><span class="pre">NeonRecording</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">video_output_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/pathlib.html#pathlib.Path" title="(in Python v3.13)"><span class="pre">Path</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'sacnpath_overlay_video.mp4'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">circle_radius</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_lines</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">line_thickness</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_video</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_fixations</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#pyneon.video.overlay_scanpath_on_video" title="Link to this definition">#</a></dt>
<dd><p>Overlay fixations and gaze data on video frames and save the resulting video.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>rec</strong> (<a class="reference internal" href="recording.html#pyneon.NeonRecording" title="pyneon.NeonRecording"><em>NeonRecording</em></a>) – Recording object containing gaze and video data.</p></li>
<li><p><strong>video_output_path</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – Path where the video with fixations will be saved.</p></li>
<li><p><strong>circle_radius</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – Radius of the circle used to represent fixations.</p></li>
<li><p><strong>line_thickness</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – Thickness of the lines connecting successive fixations.</p></li>
<li><p><strong>show_video</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – Flag to display the video with fixations overlaid in</p></li>
</ul>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>DataFrame containing the scanpath with updated fixation points.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>pd.DataFrame</p>
</dd>
</dl>
</dd></dl>
Expand Down Expand Up @@ -943,7 +933,6 @@ <h2>Returns:<a class="headerlink" href="#returns" title="Link to this heading">#
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#pyneon.video.sync_gaze_to_video"><code class="docutils literal notranslate"><span class="pre">sync_gaze_to_video()</span></code></a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#pyneon.video.estimate_scanpath"><code class="docutils literal notranslate"><span class="pre">estimate_scanpath()</span></code></a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#pyneon.video.overlay_scanpath_on_video"><code class="docutils literal notranslate"><span class="pre">overlay_scanpath_on_video()</span></code></a></li>
</ul>
</nav></div>

Expand Down
2 changes: 1 addition & 1 deletion reference/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,6 @@
<li class="toctree-l2"><a class="reference internal" href="data.html#pyneon.video.NeonVideo"><code class="docutils literal notranslate"><span class="pre">NeonVideo</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="data.html#pyneon.video.sync_gaze_to_video"><code class="docutils literal notranslate"><span class="pre">sync_gaze_to_video()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="data.html#pyneon.video.estimate_scanpath"><code class="docutils literal notranslate"><span class="pre">estimate_scanpath()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="data.html#pyneon.video.overlay_scanpath_on_video"><code class="docutils literal notranslate"><span class="pre">overlay_scanpath_on_video()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="preprocess.html">Preprocessing module</a><ul>
Expand All @@ -411,6 +410,7 @@
<li class="toctree-l1"><a class="reference internal" href="vis.html">Visualization module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="vis.html#pyneon.vis.plot_frame"><code class="docutils literal notranslate"><span class="pre">plot_frame()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="vis.html#pyneon.vis.plot_distribution"><code class="docutils literal notranslate"><span class="pre">plot_distribution()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="vis.html#pyneon.vis.plot_scanpath_on_video"><code class="docutils literal notranslate"><span class="pre">plot_scanpath_on_video()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="export.html">Exportation module</a><ul>
Expand Down
Loading

0 comments on commit 9295bab

Please sign in to comment.