Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 28 additions & 25 deletions articles/hardware/np1e/gui.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,22 @@ effect. From the GUI, you can:
- Configure the [Bno055](xref:OpenEphys.Onix1.ConfigurePolledBno055)
- Enable and disable the <xref:OpenEphys.Onix1.PolledBno055Data> stream

### Opening the GUI

The configuration dialog is accessible by double-clicking on the
<xref:OpenEphys.Onix1.ConfigureHeadstageNeuropixelsV1e> operator.

To open the headstage configuration GUI, double-click the `ConfigureHeadstageNeuropixelsV1e`
operator.

![Open the GUI](../../..//images/neuropixelsv1e-gui-tut/where-to-click.png)

Once opened, if the calibration files have not been selected the window should look like the image
below. To view the probe, follow the steps below to [choose calibration
files](#choosing-probe-calibration-files).

![Headstage Configuration GUI](../../..//images/neuropixelsv1e-gui-tut/headstage-configuration-dialog.png)

### Channel constraints

For `NeuropixelsV1e`, there will always be 384 channels enabled across the entire probe. Therefore,
Expand Down Expand Up @@ -82,18 +95,7 @@ saved to a [JSON file](#save-probeinterface-file). Conversely, an existing JSON
the default configuration is needed, it can be [loaded again](#load-default-configuration) at any
time.

## Open Headstage Configuration GUI

To open the headstage configuration GUI, double-click the `ConfigureHeadstageNeuropixelsV1e`
operator.

![Open the GUI](../../..//images/neuropixelsv1e-gui-tut/bonsai-editor-where-to-click.png)

Once opened, if the calibration files have not been selected the window should look like the image
below. To view the probe, follow the steps below to [choose calibration
files](#choosing-probe-calibration-files).

![Probe Configuration GUI](../../..//images/neuropixelsv1e-gui-tut/headstage-configuration-dialog.png)
## Neuropixels V1 Probe Configuration

### Choosing probe calibration files

Expand Down Expand Up @@ -233,7 +235,7 @@ choose electrodes.
- Mouse Controls
- Mouse wheel zooms in/out towards the cursor
- Left-click and drag will select electrodes within the drawn rectangle
- Left-click on an electrode will select that electrode
- Left-click on an electrode will toggle that electrode
- Left-click in empty space will clear the selected electrodes
- Middle-click and drag will pan the electrodes
- Scroll bar
Expand All @@ -244,16 +246,19 @@ choose electrodes.
- Placing the cursor either above or below the marker and clicking
- Using the mouse wheel to scroll up or down while the cursor is over the scroll bar

### Zoom and pan limits
### Reset Zoom

When zooming in and out, note that there are limits in both directions. The probe can only be zoomed
out to the point that the entire probe is visible within the panel and no more. Similarly, while
zooming in the probe will not zoom in past a certain point.
When zooming in and out, there are limits in both directions. The probe can only be zoomed out to
the point that the entire probe is visible within the panel, and similarly the probe will not zoom
in past a certain point.

In addition to the absolute zoom limits, the panel will automatically shift the probe to ensure it
is always in view. This is handled each time the probe is zoomed or panned.
There are no restrictions when panning the probe, meaning that it is possible to move the probe to
where it is out of view, and difficult to find. To reset the view at any time, click on the `Reset
Zoom` button to fully zoom out the panel.

To reset the view at any time, click on the `Reset Zoom` button to fully zoom out the panel.
<p align="center">
<img src="../../../images/neuropixelsv1e-gui-tut/reset-zoom.png">
</p>

### Manually enabling electrodes

Expand All @@ -264,7 +269,7 @@ To select, as described [above](#maneuvering-along-the-probe), either click-and-
the desired electrodes, or select individual electrodes by clicking on them one-by-one. Once the
electrodes to enable are selected, click on the `Enable Selected Electrodes` button in the right
panel. At this point the selected electrodes should turn blue, indicating that they are now enabled.
It is important to note that when electrodes are enabled, a number of previously enabled electrodes
It is important to note that when electrodes are enabled, some previously enabled electrodes
will be disabled due to channel constraints. For more information, read the [Channel
constraints](#channel-constraints) section above.

Expand All @@ -274,9 +279,7 @@ Presets` drop-down changes from `BankA` to `None`. Then, once the selected elect
preset, it is automatically changed back to `BankA`.

<div>
<video width="650" height="365" controls muted loop>
<source src="../../../images/neuropixelsv1e-gui-tut/headstage-configuration-enable-electrodes.webm">
</video>
<img src="../../../images/neuropixelsv1e-gui-tut/headstage-configuration-enable-electrodes.gif">
</div>

### Loading and saving channel configurations
Expand Down Expand Up @@ -317,7 +320,7 @@ To load the default channel configuration at any time, navigate to the File drop
choose `NeuropixelsV1e → Load Default Channel Configuration`. This will load the default
configuration, with the `BankA` channel preset selected.

### Configure Bno055
## Configure Bno055

At the headstage level, there is another device tab listed for a
[Bno055](xref:OpenEphys.Onix1.PolledBno055Data). From this tab, the device can be enabled or
Expand Down
135 changes: 62 additions & 73 deletions articles/hardware/np2e/gui.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,24 @@ effect. From the GUI, you can:
- Easily visualize which electrodes are enabled
- Enable and disable the [Bno055](xref:OpenEphys.Onix1.PolledBno055Data) stream

There are two ways to access configuration dialogs; 1) at the individual
`NeuropixelsV2eProbeConfiguration` level where either `Probe A` or `Probe B` can be modified by
itself, and 2) at the headstage level where both probes can be modified, as well as the
`NeuropixelsV2eBno055` device.
### Opening the GUI

Whether the GUI is opened at the probe configuration level, or the headstage level, the usage will
be almost identical. There are some additional tabs present at the headstage level, but the `Probe
A` and `Probe B` tabs will act exactly the same as opening a probe configuration GUI for that
specific probe.
This configuration GUI can be accessed by double-clicking on the
<xref:OpenEphys.Onix1.ConfigureHeadstageNeuropixelsV2e> operator when the workflow is not running.

<p align="center">
<img src="../../../images/neuropixelsv2e-gui-tut/where-to-click.png">
</p>

Once opened, if no probe calibration file has been selected the window should look like the image
below. To view the probe, follow the steps [below](#choosing-a-probe-calibration-file).

<p align="center">
<img src="../../../images/neuropixelsv2e-gui-tut/headstage-configuration-dialog.png">
</p>

> [!TIP]
> The controls shown for this GUI are the same as the ones shown for the `NeuropixelsV2e Headstage Configuration` below.

### Channel constraints

Expand Down Expand Up @@ -64,7 +73,7 @@ highest indexed electrode is the only one that will be enabled.
### Keeping or discarding configuration settings

While the GUI is open, any changes to the configuration settings can be freely modified and will not
affect the configuration unless <kbd>Ok</kbd> is pressed. This includes all aspects of the
affect the configuration unless <kbd>OK</kbd> is pressed. This includes all aspects of the
configuration, such as which electrodes are enabled, the chosen reference channel, and the probe
calibration file.

Expand All @@ -88,22 +97,30 @@ saved to a [JSON file](#save-probeinterface-file). Conversely, an existing JSON
the default configuration is needed, it can be [loaded again](#load-default-configuration) at any
time.

## Open Probe Configuration GUI
## Neuropixels V2 Probe Configuration

![Open the GUI](../../../images/neuropixelsv2e-gui-tut/bonsai-editor-where-to-click.png)
There are two ways to access the interface for each Neuropixels V2 probe:

Steps to open the Probe Configuration GUI:
- Select the `ConfigureHeadstageNeuropixelsV2e` node.
- Click on the `NeuropixelsV2eProbeConfiguration` to edit (either `ProbeConfigurationA` or `ProbeConfigurationB`).
- Select the <kbd>...</kbd> button on the right-most part of the property pane (#1 above).
1. Click on the `Probe A` tab after opening the headstage GUI (see
[above](#opening-the-gui)). Note that this is the default tab that is opened first when the
headstage GUI is opened.

Once opened, if no probe calibration file has been selected the window should look like the image
below. To view the probe, follow the steps [below](#choosing-a-probe-calibration-file).
<p align="center">
<img src="../../../images/neuropixelsv2e-gui-tut/headstage-dialog-probe-a.png">
</p>

![Probe Configuration GUI](../../../images/neuropixelsv2e-gui-tut/probeconfiguration-dialog.png)
2. From the main Bonsai editor, select the `ProbeConfigurationA` property from the Devices
category, and click on the <kbd>...</kbd> button to the right of the name.

> [!TIP]
> The controls shown for this GUI are the same as the ones shown for the `NeuropixelsV2e Headstage Configuration` below.
<p align="center">
<img src="../../../images/neuropixelsv2e-gui-tut/probe-a-ellipsis.png">
</p>

Whichever method is used to open the GUI, the descriptions below will be the same for both.
However, if method 2 is used, other devices are not available from the same window; the
`Probe Configuration` window must be closed so that another device (or the headstage) GUI can be
opened. If any changes are made while the device-specific window is opened that you want to save, be
sure to [save the settings](#saving-settings).

### Choosing a probe calibration file

Expand All @@ -113,7 +130,7 @@ ellipsis button to the right of the empty text box under "Probe Calibration File
will open a file dialog, where the calibration file can be searched for and selected.

<p align="center">
<img src="../../../images/neuropixelsv2e-gui-tut/probeconfiguration-filecalibration.png">
<img src="../../../images/neuropixelsv2e-gui-tut/headstage-choose-calibration-file.png">
</p>

> [!NOTE]
Expand All @@ -125,26 +142,28 @@ the Probe Configuration GUI that has been opened for `Probe A` with a gain calib
selected. Note that the `Gain Correction` textbox and the `Gain Calibration SN: ` status strip are
automatically filled in with values found in the calibration file.

![Probe Configuration GUI with Probe shown](../../../images/neuropixelsv2e-gui-tut/probeconfiguration-dialog-with-probe.png)

### Selecting channel reference

<p align="center">
<img src="../../../images/neuropixelsv2e-gui-tut/probeconfiguration-reference.png">
<img src="../../../images/neuropixelsv2e-gui-tut/headstage-files-selected.png">
</p>

### Selecting channel reference

Underneath the probe calibration filepath, there is a dropdown menu for choosing the reference for
all channels. For possible values and a brief description of what they correspond to, check out the
[references page](xref:OpenEphys.Onix1.NeuropixelsV2QuadShankReference).

<p align="center">
<img src="../../../images/neuropixelsv2e-gui-tut/headstage-reference.png">
</p>

### Channel presets

To save time, it is possible to select a preset channel combination from the `Channel Presets`
dropdown. These presets are defined to work within the constraints of `NeuropixelsV2e` channel
combinations defined [above](#channel-constraints).

<p align="center">
<img src="../../../images/neuropixelsv2e-gui-tut/probeconfiguration-channelpresets.png">
<img src="../../../images/neuropixelsv2e-gui-tut/headstage-channel-presets.png">
</p>

Channel presets follow one of these patterns:
Expand Down Expand Up @@ -193,16 +212,19 @@ electrodes.
- Placing the cursor either above or below the marker and clicking
- Using the mouse wheel to scroll up or down while the cursor is over the scroll bar

### Zoom and pan limits
### Reset Zoom

When zooming in and out, note that there are limits in both directions. The probe can only be zoomed
out to the point that the entire probe is visible within the panel and no more. Similarly, while
zooming in the probe will not zoom in past a certain point.
When zooming in and out, there are limits in both directions. The probe can only be zoomed out to
the point that the entire probe is visible within the panel, and similarly the probe will not zoom
in past a certain point.

In addition to the absolute zoom limits, the panel will automatically shift the probe to ensure it
is always in view. This is handled each time the probe is zoomed or panned.
There are no restrictions when panning the probe, meaning that it is possible to move the probe to
where it is out of view, and difficult to find. To reset the view at any time, click on the `Reset
Zoom` button to fully zoom out the panel.

To reset the view at any time, click on the `Reset Zoom` button to fully zoom out the panel.
<p align="center">
<img src="../../../images/neuropixelsv2e-gui-tut/reset-zoom.png">
</p>

### Manually enabling electrodes

Expand All @@ -223,9 +245,7 @@ Presets` drop-down changes from `Shank0BankA` to `None`. Then, once the selected
the preset, it is automatically changed back to `Shank0BankA`.

<div>
<video width="650" height="365" controls muted loop>
<source src="../../../images/neuropixelsv2e-gui-tut/probeconfiguration-enable-electrodes.webm">
</video>
<img src="../../../images/neuropixelsv2e-gui-tut/headstage-configuration-enable-electrodes.gif">
</div>

### Loading and saving channel configurations
Expand All @@ -237,7 +257,7 @@ preset selected. To load a new configuration, load the default configuration, or
configuration, go to the File drop-down menu (see below) and choose the relevant option.

<p align="center">
<img src="../../../images/neuropixelsv2e-gui-tut/probeconfiguration-filemenu.png">
<img src="../../../images/neuropixelsv2e-gui-tut/headstage-file-menu.png">
</p>

#### Save ProbeInterface file
Expand Down Expand Up @@ -266,45 +286,14 @@ To load the default channel configuration at any time, navigate to the File drop
choose `Load Default Channel Configuration`. This will load the default configuration, with the
`Shank0BankA` channel preset selected.

## Open Headstage Configuration GUI

![Open the GUI](../../../images/neuropixelsv2e-gui-tut/bonsai-editor-where-to-click.png)

Step to open the headstage configuration GUI

- Double-click the `ConfigureHeadstageNeuropixelsV2e` node (#2 above)

Once opened, if no probe calibration is selected for either `Probe A` or `Probe B`, then both tabs
will only show their controls on the right and no probes (see below).

![Headstage Configuration GUI](../../../images/neuropixelsv2e-gui-tut/headstage-dialog.png)

### Configure Probe A

Using the headstage configuration GUI is exactly the same as using the [probe configuration
GUI](#open-probe-configuration-gui). After the GUI has been
[opened](#open-headstage-configuration-gui) and a probe calibration file has been
[selected](#choosing-a-probe-calibration-file), `Probe A` will be drawn in the corresponding tab
(see below).

![Headstage Configuration GUI with probe A](../../../images/neuropixelsv2e-gui-tut/headstage-dialog-with-probe-a.png)

### Configure Probe B

Using the headstage configuration GUI is exactly the same as using the [probe configuration
GUI](#open-probe-configuration-gui). After the GUI has been
[opened](#open-headstage-configuration-gui) and a probe calibration file has been
[selected](#choosing-a-probe-calibration-file), `Probe B` will be drawn in the corresponding tab
(see below).

![Headstage Configuration GUI with probe B](../../../images/neuropixelsv2e-gui-tut/headstage-dialog-with-probe-b.png)

### Configure Bno055
## Configure Bno055

At the headstage level, there is another device tab listed for a
[Bno055](xref:OpenEphys.Onix1.PolledBno055Data). From this tab, the device can be enabled or
disabled by selecting the appropriate value from the drop-down menu next to `Enable`. While the
`DeviceAddress` and `DeviceName` values are modifiable here, they have no affect on the underlying
device configuration; only changes to the `Enable` property will be respected.

![Headstage Configuration GUI with Bno055](../../../images/neuropixelsv2e-gui-tut/headstage-dialog-with-bno055.png)
<p align="center">
<img src="../../../images/neuropixelsv2e-gui-tut/headstage-bno055.png">
</p>
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/neuropixelsv1e-gui-tut/headstage-ap-correction.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/neuropixelsv1e-gui-tut/headstage-bno055.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/neuropixelsv1e-gui-tut/headstage-channel-presets.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/neuropixelsv1e-gui-tut/headstage-configuration-dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file modified images/neuropixelsv1e-gui-tut/headstage-files-selected.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/neuropixelsv1e-gui-tut/headstage-invert-polarity.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/neuropixelsv1e-gui-tut/headstage-lfp-correction.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/neuropixelsv1e-gui-tut/headstage-reference.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/neuropixelsv1e-gui-tut/headstage-spike-filter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/neuropixelsv1e-gui-tut/reset-zoom.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/neuropixelsv1e-gui-tut/where-to-click.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Diff not rendered.
Binary file modified images/neuropixelsv2e-gui-tut/headstage-invert-polarity.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file not shown.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file added images/neuropixelsv2e-gui-tut/reset-zoom.png
Binary file added images/neuropixelsv2e-gui-tut/where-to-click.png
Binary file not shown.

Large diffs are not rendered by default.

Binary file not shown.
65 changes: 65 additions & 0 deletions img-src/neuropixelsv1e-gui/headstage-ap-correction.svg

Large diffs are not rendered by default.

Binary file not shown.
50 changes: 50 additions & 0 deletions img-src/neuropixelsv1e-gui/headstage-bno055.svg

Large diffs are not rendered by default.

Binary file removed img-src/neuropixelsv1e-gui/headstage-bno055.xcf
Binary file not shown.
65 changes: 65 additions & 0 deletions img-src/neuropixelsv1e-gui/headstage-channel-presets.svg

Large diffs are not rendered by default.

Binary file not shown.
50 changes: 50 additions & 0 deletions img-src/neuropixelsv1e-gui/headstage-configuration-dialog.svg

Large diffs are not rendered by default.

Binary file not shown.
62 changes: 62 additions & 0 deletions img-src/neuropixelsv1e-gui/headstage-files-selected.svg

Large diffs are not rendered by default.

Binary file not shown.

Large diffs are not rendered by default.

Binary file not shown.
65 changes: 65 additions & 0 deletions img-src/neuropixelsv1e-gui/headstage-invert-polarity.svg

Large diffs are not rendered by default.

65 changes: 65 additions & 0 deletions img-src/neuropixelsv1e-gui/headstage-lfp-correction.svg

Large diffs are not rendered by default.

Binary file not shown.
65 changes: 65 additions & 0 deletions img-src/neuropixelsv1e-gui/headstage-reference.svg

Large diffs are not rendered by default.

Binary file removed img-src/neuropixelsv1e-gui/headstage-reference.xcf
Binary file not shown.
65 changes: 65 additions & 0 deletions img-src/neuropixelsv1e-gui/headstage-spike-filter.svg

Large diffs are not rendered by default.

Binary file not shown.
65 changes: 65 additions & 0 deletions img-src/neuropixelsv1e-gui/reset-zoom.svg

Large diffs are not rendered by default.

53 changes: 53 additions & 0 deletions img-src/neuropixelsv1e-gui/where-to-click.svg

Large diffs are not rendered by default.

Binary file not shown.
50 changes: 50 additions & 0 deletions img-src/neuropixelsv2e-gui/headstage-bno055.svg

Large diffs are not rendered by default.

53 changes: 53 additions & 0 deletions img-src/neuropixelsv2e-gui/headstage-channel-presets.svg

Large diffs are not rendered by default.

53 changes: 53 additions & 0 deletions img-src/neuropixelsv2e-gui/headstage-choose-calibration-file.svg

Large diffs are not rendered by default.

50 changes: 50 additions & 0 deletions img-src/neuropixelsv2e-gui/headstage-configuration-dialog.svg

Large diffs are not rendered by default.

53 changes: 53 additions & 0 deletions img-src/neuropixelsv2e-gui/headstage-dialog-probe-a.svg

Large diffs are not rendered by default.

Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed img-src/neuropixelsv2e-gui/headstage-dialog.xcf
Binary file not shown.
53 changes: 53 additions & 0 deletions img-src/neuropixelsv2e-gui/headstage-file-menu.svg

Large diffs are not rendered by default.

50 changes: 50 additions & 0 deletions img-src/neuropixelsv2e-gui/headstage-file-selected.svg

Large diffs are not rendered by default.

53 changes: 53 additions & 0 deletions img-src/neuropixelsv2e-gui/headstage-invert-polarity.svg

Large diffs are not rendered by default.

53 changes: 53 additions & 0 deletions img-src/neuropixelsv2e-gui/headstage-reference.svg

Large diffs are not rendered by default.

53 changes: 53 additions & 0 deletions img-src/neuropixelsv2e-gui/probe-a-ellipsis.svg

Large diffs are not rendered by default.

Binary file not shown.
Binary file not shown.
Binary file not shown.
53 changes: 53 additions & 0 deletions img-src/neuropixelsv2e-gui/reset-zoom.svg

Large diffs are not rendered by default.

53 changes: 53 additions & 0 deletions img-src/neuropixelsv2e-gui/where-to-click.svg

Large diffs are not rendered by default.