Skip to content

Commit

Permalink
Add images to README
Browse files Browse the repository at this point in the history
  • Loading branch information
jsiegle committed Sep 16, 2022
1 parent bc7db9a commit 1fa2d46
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Probe Viewer

Visualizes the signal from a linear probe as a heatmap (time x channels). Can be configured to show RMS signal, spike rate, or power in different frequency bands.
![probe-viewer-editor](https://open-ephys.github.io/gui-docs/_images/probeviewer-01.png)

Visualizes the signal from a high-channel-count linear probe as a heatmap (**time** x **channels**). Can be configured to display RMS signal, spike rate, or power in different frequency bands.

## Installation

Expand All @@ -10,18 +12,20 @@ This plugin can be added via the Open Ephys GUI Plugin Installer. To access the

### Plugin Editor

* `Displayed Stream` controls the currently selected stream to be viewed. Supports changing the stream while acquisition is active.
`Displayed Stream` controls the currently selected stream to be viewed. The selected stream can be changed while acquisition is active.

### Visualizer Window

* #### Channel Browser:
* This interface on the left allows you to select which region of the "probe" is to be viewed. You can either view the entire "probe" or just a subsection of it.
![probe-viewer-visualizer](https://open-ephys.github.io/gui-docs/_images/probeviewer-02.png)

#### Channel Browser

* #### Display Options:
Used to select a region of the probe to view.

* **Render Mode** - RMS, Frequency Band Power, or Spike Rate. Each Mode has its own specific options.
* **Colour Scheme** - List of available colour schemes
#### Display Options

* **Render Mode** - RMS amplitude, Frequency Band Power, or Spike Rate.
* **Colour Scheme** - Inferno, Plasma, Magma, Viridis, Jet

## Building from source

Expand Down

0 comments on commit 1fa2d46

Please sign in to comment.