Skip to content

Commit 44afcac

Browse files
committed
Update documentation
1 parent fbf9f40 commit 44afcac

File tree

6 files changed

+12
-3
lines changed

6 files changed

+12
-3
lines changed

User-Manual/Plugins/LFP-Viewer.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -552,7 +552,7 @@ <h4>Thresholds<a class="headerlink" href="#thresholds" title="Permalink to this
552552
<h4>Channels<a class="headerlink" href="#channels" title="Permalink to this heading">#</a></h4>
553553
<ul class="simple">
554554
<li><p><strong>Reverse order:</strong> Displays the channels in opposite numerical order (highest-numbered channels at the top of the screen).</p></li>
555-
<li><p><strong>Sort by depth:</strong> Displays the channels by depth, if this information is available. Currently, there are no source nodes that include this information, although this will change soon.</p></li>
555+
<li><p><strong>Sort by depth:</strong> Displays the channels by depth, if this information is available. Currently, only the <a class="reference internal" href="Neuropixels-PXI.html#neuropixelspxi"><span class="std std-ref">Neuropixels PXI</span></a> plugin includes information about channel depth.</p></li>
556556
<li><p><strong>Skip:</strong> Sets the display to show every Nth channel. This is useful if you’re using a probe with many densely space contacts, and don’t need to visualize every one simultaneously.</p></li>
557557
<li><p><strong>Show number</strong>: Displays the channel indices, rather than the channel names, on the left-hand side of the LFP Viewer.</p></li>
558558
</ul>

User-Manual/Plugins/Probe-Viewer.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -537,6 +537,10 @@ <h3>Render modes<a class="headerlink" href="#render-modes" title="Permalink to t
537537
<li><p><strong>Spike Rate</strong> - Color corresponds to the number of threshold crossings per unit time within each pixel window. The threshold voltage can be adjusted.</p></li>
538538
</ol>
539539
</section>
540+
<section id="channel-ordering">
541+
<h3>Channel ordering<a class="headerlink" href="#channel-ordering" title="Permalink to this heading">#</a></h3>
542+
<p>The Probe Viewer will automatically sort channels by depth, if this information is available. Currently, the <a class="reference internal" href="Neuropixels-PXI.html#neuropixelspxi"><span class="std std-ref">Neuropixels PXI</span></a> plugin is the only upstream plugin that tags channels with depth information. Therefore, if you are using Neuropixels probes, the Probe Viewer will first sort channels by shank, and then by depth within each shank. Note that since channels not mapped to contiguous electrodes on Neuropixels 2.0 probes, this will result in the channels appearing “out of order” in the Probe Viewer display.</p>
543+
</section>
540544
</section>
541545
<section id="anatomy-overlay">
542546
<h2>Anatomy overlay<a class="headerlink" href="#anatomy-overlay" title="Permalink to this heading">#</a></h2>
@@ -647,6 +651,7 @@ <h3>Via config messages<a class="headerlink" href="#via-config-messages" title="
647651
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#recommended-signal-chain">Recommended signal chain</a></li>
648652
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#plugin-configuration">Plugin configuration</a><ul class="nav section-nav flex-column">
649653
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#render-modes">Render modes</a></li>
654+
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#channel-ordering">Channel ordering</a></li>
650655
</ul>
651656
</li>
652657
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#anatomy-overlay">Anatomy overlay</a><ul class="nav section-nav flex-column">

_sources/User-Manual/Plugins/LFP-Viewer.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Channels
7373

7474
* **Reverse order:** Displays the channels in opposite numerical order (highest-numbered channels at the top of the screen).
7575

76-
* **Sort by depth:** Displays the channels by depth, if this information is available. Currently, there are no source nodes that include this information, although this will change soon.
76+
* **Sort by depth:** Displays the channels by depth, if this information is available. Currently, only the :ref:`neuropixelspxi` plugin includes information about channel depth.
7777

7878
* **Skip:** Sets the display to show every Nth channel. This is useful if you're using a probe with many densely space contacts, and don't need to visualize every one simultaneously.
7979

_sources/User-Manual/Plugins/Probe-Viewer.rst.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,10 @@ Render modes
5050

5151
3. **Spike Rate** - Color corresponds to the number of threshold crossings per unit time within each pixel window. The threshold voltage can be adjusted.
5252

53+
Channel ordering
54+
----------------
55+
56+
The Probe Viewer will automatically sort channels by depth, if this information is available. Currently, the :ref:`neuropixelspxi` plugin is the only upstream plugin that tags channels with depth information. Therefore, if you are using Neuropixels probes, the Probe Viewer will first sort channels by shank, and then by depth within each shank. Note that since channels not mapped to contiguous electrodes on Neuropixels 2.0 probes, this will result in the channels appearing "out of order" in the Probe Viewer display.
5357

5458
Anatomy overlay
5559
#####################

objects.inv

18 Bytes
Binary file not shown.

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)