Skip to content

Commit 557d181

Browse files
actions-useractions-user
committed
Update documentation
1 parent 94f80bd commit 557d181

File tree

74 files changed

+1466
-13
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+1466
-13
lines changed

‎Tutorials/How-To-Make-Your-Own-Plugin.html

+6-1
Original file line numberDiff line numberDiff line change
@@ -512,13 +512,18 @@ <h2>Editing <code class="code docutils literal notranslate"><span class="pre">Op
512512
<div class="line-block">
513513
<div class="line"><br /></div>
514514
</div>
515-
<p>Next, rename the source files:</p>
515+
<p>Next, rename the source files to match the name of your plugin</p>
516516
<ul class="simple">
517517
<li><p><code class="code docutils literal notranslate"><span class="pre">ProcessorPlugin.h</span></code> –&gt; <code class="code docutils literal notranslate"><span class="pre">TTLEventGenerator.h</span></code></p></li>
518518
<li><p><code class="code docutils literal notranslate"><span class="pre">ProcessorPlugin.cpp</span></code> –&gt; <code class="code docutils literal notranslate"><span class="pre">TTLEventGenerator.cpp</span></code></p></li>
519519
<li><p><code class="code docutils literal notranslate"><span class="pre">ProcessorPluginEditor.h</span></code> –&gt; <code class="code docutils literal notranslate"><span class="pre">TTLEventGeneratorEditor.h</span></code></p></li>
520520
<li><p><code class="code docutils literal notranslate"><span class="pre">ProcessorPluginEditor.cpp</span></code> –&gt; <code class="code docutils literal notranslate"><span class="pre">TTLEventGeneratorEditor.cpp</span></code></p></li>
521521
</ul>
522+
<p>and update the class names inside each file to match the new names:</p>
523+
<ul class="simple">
524+
<li><p><code class="code docutils literal notranslate"><span class="pre">ProcessorPlugin</span></code> –&gt; <code class="code docutils literal notranslate"><span class="pre">TTLEventGenerator</span></code></p></li>
525+
<li><p><code class="code docutils literal notranslate"><span class="pre">ProcessorPluginEditor</span></code> –&gt; <code class="code docutils literal notranslate"><span class="pre">TTLEventGeneratorEditor</span></code></p></li>
526+
</ul>
522527
<p>Finally, update the include inside <code class="code docutils literal notranslate"><span class="pre">OpenEphysLib.cpp</span></code> from <code class="code docutils literal notranslate"><span class="pre">#include</span> <span class="pre">&quot;ProcessorPlugin.h&quot;</span></code> to <code class="code docutils literal notranslate"><span class="pre">#include</span> <span class="pre">&quot;TTLEventGenerator.h&quot;</span></code>.</p>
523528
</section>
524529
<section id="compiling-your-plugin">

‎User-Manual/Before-you-begin.html

+1
Original file line numberDiff line numberDiff line change
@@ -391,6 +391,7 @@
391391
<li class="toctree-l2"><a class="reference internal" href="Plugins/Falcon-Output.html">Falcon Output</a></li>
392392
<li class="toctree-l2"><a class="reference internal" href="Plugins/File-Reader.html">File Reader</a></li>
393393
<li class="toctree-l2"><a class="reference internal" href="Plugins/Intan-RHD-USB.html">Intan RHD USB</a></li>
394+
<li class="toctree-l2"><a class="reference internal" href="Plugins/Latency-Histogram.html">Latency Histogram</a></li>
394395
<li class="toctree-l2"><a class="reference internal" href="Plugins/LFP-Viewer.html">LFP Viewer</a></li>
395396
<li class="toctree-l2"><a class="reference internal" href="Plugins/LSL-Inlet.html">LSL Inlet</a></li>
396397
<li class="toctree-l2"><a class="reference internal" href="Plugins/MATLAB-Interface.html">MATLAB Interface</a></li>

‎User-Manual/Building-a-signal-chain.html

+1
Original file line numberDiff line numberDiff line change
@@ -391,6 +391,7 @@
391391
<li class="toctree-l2"><a class="reference internal" href="Plugins/Falcon-Output.html">Falcon Output</a></li>
392392
<li class="toctree-l2"><a class="reference internal" href="Plugins/File-Reader.html">File Reader</a></li>
393393
<li class="toctree-l2"><a class="reference internal" href="Plugins/Intan-RHD-USB.html">Intan RHD USB</a></li>
394+
<li class="toctree-l2"><a class="reference internal" href="Plugins/Latency-Histogram.html">Latency Histogram</a></li>
394395
<li class="toctree-l2"><a class="reference internal" href="Plugins/LFP-Viewer.html">LFP Viewer</a></li>
395396
<li class="toctree-l2"><a class="reference internal" href="Plugins/LSL-Inlet.html">LSL Inlet</a></li>
396397
<li class="toctree-l2"><a class="reference internal" href="Plugins/MATLAB-Interface.html">MATLAB Interface</a></li>

‎User-Manual/Exploring-the-user-interface.html

+1
Original file line numberDiff line numberDiff line change
@@ -391,6 +391,7 @@
391391
<li class="toctree-l2"><a class="reference internal" href="Plugins/Falcon-Output.html">Falcon Output</a></li>
392392
<li class="toctree-l2"><a class="reference internal" href="Plugins/File-Reader.html">File Reader</a></li>
393393
<li class="toctree-l2"><a class="reference internal" href="Plugins/Intan-RHD-USB.html">Intan RHD USB</a></li>
394+
<li class="toctree-l2"><a class="reference internal" href="Plugins/Latency-Histogram.html">Latency Histogram</a></li>
394395
<li class="toctree-l2"><a class="reference internal" href="Plugins/LFP-Viewer.html">LFP Viewer</a></li>
395396
<li class="toctree-l2"><a class="reference internal" href="Plugins/LSL-Inlet.html">LSL Inlet</a></li>
396397
<li class="toctree-l2"><a class="reference internal" href="Plugins/MATLAB-Interface.html">MATLAB Interface</a></li>

‎User-Manual/Hardware-requirements.html

+1
Original file line numberDiff line numberDiff line change
@@ -391,6 +391,7 @@
391391
<li class="toctree-l2"><a class="reference internal" href="Plugins/Falcon-Output.html">Falcon Output</a></li>
392392
<li class="toctree-l2"><a class="reference internal" href="Plugins/File-Reader.html">File Reader</a></li>
393393
<li class="toctree-l2"><a class="reference internal" href="Plugins/Intan-RHD-USB.html">Intan RHD USB</a></li>
394+
<li class="toctree-l2"><a class="reference internal" href="Plugins/Latency-Histogram.html">Latency Histogram</a></li>
394395
<li class="toctree-l2"><a class="reference internal" href="Plugins/LFP-Viewer.html">LFP Viewer</a></li>
395396
<li class="toctree-l2"><a class="reference internal" href="Plugins/LSL-Inlet.html">LSL Inlet</a></li>
396397
<li class="toctree-l2"><a class="reference internal" href="Plugins/MATLAB-Interface.html">MATLAB Interface</a></li>

‎User-Manual/Installing-the-GUI.html

+1
Original file line numberDiff line numberDiff line change
@@ -391,6 +391,7 @@
391391
<li class="toctree-l2"><a class="reference internal" href="Plugins/Falcon-Output.html">Falcon Output</a></li>
392392
<li class="toctree-l2"><a class="reference internal" href="Plugins/File-Reader.html">File Reader</a></li>
393393
<li class="toctree-l2"><a class="reference internal" href="Plugins/Intan-RHD-USB.html">Intan RHD USB</a></li>
394+
<li class="toctree-l2"><a class="reference internal" href="Plugins/Latency-Histogram.html">Latency Histogram</a></li>
394395
<li class="toctree-l2"><a class="reference internal" href="Plugins/LFP-Viewer.html">LFP Viewer</a></li>
395396
<li class="toctree-l2"><a class="reference internal" href="Plugins/LSL-Inlet.html">LSL Inlet</a></li>
396397
<li class="toctree-l2"><a class="reference internal" href="Plugins/MATLAB-Interface.html">MATLAB Interface</a></li>

‎User-Manual/Plugins/Acq-Board-Output.html

+1
Original file line numberDiff line numberDiff line change
@@ -391,6 +391,7 @@
391391
<li class="toctree-l2"><a class="reference internal" href="Falcon-Output.html">Falcon Output</a></li>
392392
<li class="toctree-l2"><a class="reference internal" href="File-Reader.html">File Reader</a></li>
393393
<li class="toctree-l2"><a class="reference internal" href="Intan-RHD-USB.html">Intan RHD USB</a></li>
394+
<li class="toctree-l2"><a class="reference internal" href="Latency-Histogram.html">Latency Histogram</a></li>
394395
<li class="toctree-l2"><a class="reference internal" href="LFP-Viewer.html">LFP Viewer</a></li>
395396
<li class="toctree-l2"><a class="reference internal" href="LSL-Inlet.html">LSL Inlet</a></li>
396397
<li class="toctree-l2"><a class="reference internal" href="MATLAB-Interface.html">MATLAB Interface</a></li>

‎User-Manual/Plugins/Acquisition-Board.html

+1
Original file line numberDiff line numberDiff line change
@@ -391,6 +391,7 @@
391391
<li class="toctree-l2"><a class="reference internal" href="Falcon-Output.html">Falcon Output</a></li>
392392
<li class="toctree-l2"><a class="reference internal" href="File-Reader.html">File Reader</a></li>
393393
<li class="toctree-l2"><a class="reference internal" href="Intan-RHD-USB.html">Intan RHD USB</a></li>
394+
<li class="toctree-l2"><a class="reference internal" href="Latency-Histogram.html">Latency Histogram</a></li>
394395
<li class="toctree-l2"><a class="reference internal" href="LFP-Viewer.html">LFP Viewer</a></li>
395396
<li class="toctree-l2"><a class="reference internal" href="LSL-Inlet.html">LSL Inlet</a></li>
396397
<li class="toctree-l2"><a class="reference internal" href="MATLAB-Interface.html">MATLAB Interface</a></li>

‎User-Manual/Plugins/Arduino-Output.html

+1
Original file line numberDiff line numberDiff line change
@@ -391,6 +391,7 @@
391391
<li class="toctree-l2"><a class="reference internal" href="Falcon-Output.html">Falcon Output</a></li>
392392
<li class="toctree-l2"><a class="reference internal" href="File-Reader.html">File Reader</a></li>
393393
<li class="toctree-l2"><a class="reference internal" href="Intan-RHD-USB.html">Intan RHD USB</a></li>
394+
<li class="toctree-l2"><a class="reference internal" href="Latency-Histogram.html">Latency Histogram</a></li>
394395
<li class="toctree-l2"><a class="reference internal" href="LFP-Viewer.html">LFP Viewer</a></li>
395396
<li class="toctree-l2"><a class="reference internal" href="LSL-Inlet.html">LSL Inlet</a></li>
396397
<li class="toctree-l2"><a class="reference internal" href="MATLAB-Interface.html">MATLAB Interface</a></li>

‎User-Manual/Plugins/Audio-Monitor.html

+1
Original file line numberDiff line numberDiff line change
@@ -391,6 +391,7 @@
391391
<li class="toctree-l2"><a class="reference internal" href="Falcon-Output.html">Falcon Output</a></li>
392392
<li class="toctree-l2"><a class="reference internal" href="File-Reader.html">File Reader</a></li>
393393
<li class="toctree-l2"><a class="reference internal" href="Intan-RHD-USB.html">Intan RHD USB</a></li>
394+
<li class="toctree-l2"><a class="reference internal" href="Latency-Histogram.html">Latency Histogram</a></li>
394395
<li class="toctree-l2"><a class="reference internal" href="LFP-Viewer.html">LFP Viewer</a></li>
395396
<li class="toctree-l2"><a class="reference internal" href="LSL-Inlet.html">LSL Inlet</a></li>
396397
<li class="toctree-l2"><a class="reference internal" href="MATLAB-Interface.html">MATLAB Interface</a></li>

‎User-Manual/Plugins/Bandpass-Filter.html

+1
Original file line numberDiff line numberDiff line change
@@ -391,6 +391,7 @@
391391
<li class="toctree-l2"><a class="reference internal" href="Falcon-Output.html">Falcon Output</a></li>
392392
<li class="toctree-l2"><a class="reference internal" href="File-Reader.html">File Reader</a></li>
393393
<li class="toctree-l2"><a class="reference internal" href="Intan-RHD-USB.html">Intan RHD USB</a></li>
394+
<li class="toctree-l2"><a class="reference internal" href="Latency-Histogram.html">Latency Histogram</a></li>
394395
<li class="toctree-l2"><a class="reference internal" href="LFP-Viewer.html">LFP Viewer</a></li>
395396
<li class="toctree-l2"><a class="reference internal" href="LSL-Inlet.html">LSL Inlet</a></li>
396397
<li class="toctree-l2"><a class="reference internal" href="MATLAB-Interface.html">MATLAB Interface</a></li>

‎User-Manual/Plugins/CNN-Ripple.html

+1
Original file line numberDiff line numberDiff line change
@@ -391,6 +391,7 @@
391391
<li class="toctree-l2"><a class="reference internal" href="Falcon-Output.html">Falcon Output</a></li>
392392
<li class="toctree-l2"><a class="reference internal" href="File-Reader.html">File Reader</a></li>
393393
<li class="toctree-l2"><a class="reference internal" href="Intan-RHD-USB.html">Intan RHD USB</a></li>
394+
<li class="toctree-l2"><a class="reference internal" href="Latency-Histogram.html">Latency Histogram</a></li>
394395
<li class="toctree-l2"><a class="reference internal" href="LFP-Viewer.html">LFP Viewer</a></li>
395396
<li class="toctree-l2"><a class="reference internal" href="LSL-Inlet.html">LSL Inlet</a></li>
396397
<li class="toctree-l2"><a class="reference internal" href="MATLAB-Interface.html">MATLAB Interface</a></li>

‎User-Manual/Plugins/Channel-Map.html

+1
Original file line numberDiff line numberDiff line change
@@ -391,6 +391,7 @@
391391
<li class="toctree-l2"><a class="reference internal" href="Falcon-Output.html">Falcon Output</a></li>
392392
<li class="toctree-l2"><a class="reference internal" href="File-Reader.html">File Reader</a></li>
393393
<li class="toctree-l2"><a class="reference internal" href="Intan-RHD-USB.html">Intan RHD USB</a></li>
394+
<li class="toctree-l2"><a class="reference internal" href="Latency-Histogram.html">Latency Histogram</a></li>
394395
<li class="toctree-l2"><a class="reference internal" href="LFP-Viewer.html">LFP Viewer</a></li>
395396
<li class="toctree-l2"><a class="reference internal" href="LSL-Inlet.html">LSL Inlet</a></li>
396397
<li class="toctree-l2"><a class="reference internal" href="MATLAB-Interface.html">MATLAB Interface</a></li>

‎User-Manual/Plugins/Common-Average-Reference.html

+1
Original file line numberDiff line numberDiff line change
@@ -391,6 +391,7 @@
391391
<li class="toctree-l2"><a class="reference internal" href="Falcon-Output.html">Falcon Output</a></li>
392392
<li class="toctree-l2"><a class="reference internal" href="File-Reader.html">File Reader</a></li>
393393
<li class="toctree-l2"><a class="reference internal" href="Intan-RHD-USB.html">Intan RHD USB</a></li>
394+
<li class="toctree-l2"><a class="reference internal" href="Latency-Histogram.html">Latency Histogram</a></li>
394395
<li class="toctree-l2"><a class="reference internal" href="LFP-Viewer.html">LFP Viewer</a></li>
395396
<li class="toctree-l2"><a class="reference internal" href="LSL-Inlet.html">LSL Inlet</a></li>
396397
<li class="toctree-l2"><a class="reference internal" href="MATLAB-Interface.html">MATLAB Interface</a></li>

‎User-Manual/Plugins/Crossing-Detector.html

+1
Original file line numberDiff line numberDiff line change
@@ -391,6 +391,7 @@
391391
<li class="toctree-l2"><a class="reference internal" href="Falcon-Output.html">Falcon Output</a></li>
392392
<li class="toctree-l2"><a class="reference internal" href="File-Reader.html">File Reader</a></li>
393393
<li class="toctree-l2"><a class="reference internal" href="Intan-RHD-USB.html">Intan RHD USB</a></li>
394+
<li class="toctree-l2"><a class="reference internal" href="Latency-Histogram.html">Latency Histogram</a></li>
394395
<li class="toctree-l2"><a class="reference internal" href="LFP-Viewer.html">LFP Viewer</a></li>
395396
<li class="toctree-l2"><a class="reference internal" href="LSL-Inlet.html">LSL Inlet</a></li>
396397
<li class="toctree-l2"><a class="reference internal" href="MATLAB-Interface.html">MATLAB Interface</a></li>

‎User-Manual/Plugins/Data-Snapshot.html

+1
Original file line numberDiff line numberDiff line change
@@ -391,6 +391,7 @@
391391
<li class="toctree-l2"><a class="reference internal" href="Falcon-Output.html">Falcon Output</a></li>
392392
<li class="toctree-l2"><a class="reference internal" href="File-Reader.html">File Reader</a></li>
393393
<li class="toctree-l2"><a class="reference internal" href="Intan-RHD-USB.html">Intan RHD USB</a></li>
394+
<li class="toctree-l2"><a class="reference internal" href="Latency-Histogram.html">Latency Histogram</a></li>
394395
<li class="toctree-l2"><a class="reference internal" href="LFP-Viewer.html">LFP Viewer</a></li>
395396
<li class="toctree-l2"><a class="reference internal" href="LSL-Inlet.html">LSL Inlet</a></li>
396397
<li class="toctree-l2"><a class="reference internal" href="MATLAB-Interface.html">MATLAB Interface</a></li>

‎User-Manual/Plugins/Ephys-Socket.html

+1
Original file line numberDiff line numberDiff line change
@@ -391,6 +391,7 @@
391391
<li class="toctree-l2"><a class="reference internal" href="Falcon-Output.html">Falcon Output</a></li>
392392
<li class="toctree-l2"><a class="reference internal" href="File-Reader.html">File Reader</a></li>
393393
<li class="toctree-l2"><a class="reference internal" href="Intan-RHD-USB.html">Intan RHD USB</a></li>
394+
<li class="toctree-l2"><a class="reference internal" href="Latency-Histogram.html">Latency Histogram</a></li>
394395
<li class="toctree-l2"><a class="reference internal" href="LFP-Viewer.html">LFP Viewer</a></li>
395396
<li class="toctree-l2"><a class="reference internal" href="LSL-Inlet.html">LSL Inlet</a></li>
396397
<li class="toctree-l2"><a class="reference internal" href="MATLAB-Interface.html">MATLAB Interface</a></li>

‎User-Manual/Plugins/Event-Broadcaster.html

+1
Original file line numberDiff line numberDiff line change
@@ -391,6 +391,7 @@
391391
<li class="toctree-l2"><a class="reference internal" href="Falcon-Output.html">Falcon Output</a></li>
392392
<li class="toctree-l2"><a class="reference internal" href="File-Reader.html">File Reader</a></li>
393393
<li class="toctree-l2"><a class="reference internal" href="Intan-RHD-USB.html">Intan RHD USB</a></li>
394+
<li class="toctree-l2"><a class="reference internal" href="Latency-Histogram.html">Latency Histogram</a></li>
394395
<li class="toctree-l2"><a class="reference internal" href="LFP-Viewer.html">LFP Viewer</a></li>
395396
<li class="toctree-l2"><a class="reference internal" href="LSL-Inlet.html">LSL Inlet</a></li>
396397
<li class="toctree-l2"><a class="reference internal" href="MATLAB-Interface.html">MATLAB Interface</a></li>

‎User-Manual/Plugins/Event-Translator.html

+1
Original file line numberDiff line numberDiff line change
@@ -391,6 +391,7 @@
391391
<li class="toctree-l2"><a class="reference internal" href="Falcon-Output.html">Falcon Output</a></li>
392392
<li class="toctree-l2"><a class="reference internal" href="File-Reader.html">File Reader</a></li>
393393
<li class="toctree-l2"><a class="reference internal" href="Intan-RHD-USB.html">Intan RHD USB</a></li>
394+
<li class="toctree-l2"><a class="reference internal" href="Latency-Histogram.html">Latency Histogram</a></li>
394395
<li class="toctree-l2"><a class="reference internal" href="LFP-Viewer.html">LFP Viewer</a></li>
395396
<li class="toctree-l2"><a class="reference internal" href="LSL-Inlet.html">LSL Inlet</a></li>
396397
<li class="toctree-l2"><a class="reference internal" href="MATLAB-Interface.html">MATLAB Interface</a></li>

‎User-Manual/Plugins/Falcon-Output.html

+1
Original file line numberDiff line numberDiff line change
@@ -391,6 +391,7 @@
391391
<li class="toctree-l2 current active"><a class="current reference internal" href="#">Falcon Output</a></li>
392392
<li class="toctree-l2"><a class="reference internal" href="File-Reader.html">File Reader</a></li>
393393
<li class="toctree-l2"><a class="reference internal" href="Intan-RHD-USB.html">Intan RHD USB</a></li>
394+
<li class="toctree-l2"><a class="reference internal" href="Latency-Histogram.html">Latency Histogram</a></li>
394395
<li class="toctree-l2"><a class="reference internal" href="LFP-Viewer.html">LFP Viewer</a></li>
395396
<li class="toctree-l2"><a class="reference internal" href="LSL-Inlet.html">LSL Inlet</a></li>
396397
<li class="toctree-l2"><a class="reference internal" href="MATLAB-Interface.html">MATLAB Interface</a></li>

‎User-Manual/Plugins/File-Reader.html

+1
Original file line numberDiff line numberDiff line change
@@ -391,6 +391,7 @@
391391
<li class="toctree-l2"><a class="reference internal" href="Falcon-Output.html">Falcon Output</a></li>
392392
<li class="toctree-l2 current active"><a class="current reference internal" href="#">File Reader</a></li>
393393
<li class="toctree-l2"><a class="reference internal" href="Intan-RHD-USB.html">Intan RHD USB</a></li>
394+
<li class="toctree-l2"><a class="reference internal" href="Latency-Histogram.html">Latency Histogram</a></li>
394395
<li class="toctree-l2"><a class="reference internal" href="LFP-Viewer.html">LFP Viewer</a></li>
395396
<li class="toctree-l2"><a class="reference internal" href="LSL-Inlet.html">LSL Inlet</a></li>
396397
<li class="toctree-l2"><a class="reference internal" href="MATLAB-Interface.html">MATLAB Interface</a></li>

‎User-Manual/Plugins/Intan-RHD-USB.html

+4-3
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
<link rel="icon" href="../../_static/favicon.png"/>
4343
<link rel="index" title="Index" href="../../genindex.html" />
4444
<link rel="search" title="Search" href="../../search.html" />
45-
<link rel="next" title="LFP Viewer" href="LFP-Viewer.html" />
45+
<link rel="next" title="Latency Histogram" href="Latency-Histogram.html" />
4646
<link rel="prev" title="File Reader" href="File-Reader.html" />
4747
<meta name="viewport" content="width=device-width, initial-scale=1"/>
4848
<meta name="docsearch:language" content="en"/>
@@ -391,6 +391,7 @@
391391
<li class="toctree-l2"><a class="reference internal" href="Falcon-Output.html">Falcon Output</a></li>
392392
<li class="toctree-l2"><a class="reference internal" href="File-Reader.html">File Reader</a></li>
393393
<li class="toctree-l2 current active"><a class="current reference internal" href="#">Intan RHD USB</a></li>
394+
<li class="toctree-l2"><a class="reference internal" href="Latency-Histogram.html">Latency Histogram</a></li>
394395
<li class="toctree-l2"><a class="reference internal" href="LFP-Viewer.html">LFP Viewer</a></li>
395396
<li class="toctree-l2"><a class="reference internal" href="LSL-Inlet.html">LSL Inlet</a></li>
396397
<li class="toctree-l2"><a class="reference internal" href="MATLAB-Interface.html">MATLAB Interface</a></li>
@@ -609,11 +610,11 @@ <h3>Impedance testing<a class="headerlink" href="#impedance-testing" title="Perm
609610
</div>
610611
</a>
611612
<a class="right-next"
612-
href="LFP-Viewer.html"
613+
href="Latency-Histogram.html"
613614
title="next page">
614615
<div class="prev-next-info">
615616
<p class="prev-next-subtitle">next</p>
616-
<p class="prev-next-title">LFP Viewer</p>
617+
<p class="prev-next-title">Latency Histogram</p>
617618
</div>
618619
<i class="fa-solid fa-angle-right"></i>
619620
</a>

0 commit comments

Comments
 (0)