Skip to content

Commit 57ac8c5

Browse files
committed
Update 0.4.5
- This requires changing workflows and some information in the docs because NeuropixelsVxyzHeadstage was changed to HeadstageNeuropixelsVxyz in the src code
1 parent abc1e07 commit 57ac8c5

File tree

58 files changed

+344
-2785
lines changed

Some content is hidden

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

58 files changed

+344
-2785
lines changed

articles/getting-started/onix-acquisition.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ Linking the data I/O operator to devices when using two identical headstages or
3232
miniscopes involves an additional step: renaming a configuration operator.
3333
Suppose you want to stream orientation data from two Neuropixels 2.0 Headstages
3434
through using two <xref:OpenEphys.Onix1.PolledBno055Data> operators. By default,
35-
the <xref:OpenEphys.Onix1.ConfigureNeuropixelsV2eHeadstage> operators are both
36-
named "NeuropixelsV2eHeadstage". This causes their devices to also have
37-
identical names, "NeuropixelsV2eHeadstage/PolledBno055". The two headstages and
35+
the <xref:OpenEphys.Onix1.ConfigureHeadstageNeuropixelsV2e> operators are both
36+
named "HeadstageNeuropixelsV2e". This causes their devices to also have
37+
identical names, "HeadstageNeuropixelsV2e/PolledBno055". The two headstages and
3838
their devices must be disambiguated. To do this, you must edit one or both of
3939
headstages' `Name` property:
4040

@@ -46,8 +46,8 @@ After this, the disambiguated source can be selected for each data operator
4646

4747

4848
In the following workflow workflow, the `Name` property of each
49-
<xref:OpenEphys.Onix1.ConfigureNeuropixelsV2eHeadstage> has been changed from
50-
"NeuropixelsV2eHeadstage" to "HS-NPX-AB" and "HS-NPX-B". The `DeviceName` of
49+
<xref:OpenEphys.Onix1.ConfigureHeadstageNeuropixelsV2e> has been changed from
50+
"HeadstageNeuropixelsV2e" to "HS-NPX-AB" and "HS-NPX-B". The `DeviceName` of
5151
each of the <xref:OpenEphys.Onix1.PolledBno055Data> operators has been set to
5252
"HS-NPX-A/PolledBno055" and "HS-NPX-B/PolledBno055" from the dropdown so each
5353
operator will take data from a different headstage.

articles/hardware/np1e/bno055.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ title: NeuropixelsV1e Bno055
44
bno055: true
55
hardware: NeuropixelsV1e Headstage
66
bnoOperator: PolledBno055Data
7-
hardwareOperator: NeuropixelsV1eHeadstage
7+
hardwareOperator: HeadstageNeuropixelsV1e
88
workflowLocation: overview
99
---

articles/hardware/np1e/configuration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ uid: np1e_configuration
33
title: NeuropixelsV1e Headstage Configuration
44
hardware: NeuropixelsV1e Headstage
55
configuration: true
6-
operator: ConfigureNeuropixelsV1eHeadstage
6+
operator: ConfigureHeadstageNeuropixelsV1e
77
dataRate: 20.6
88
timeUntilFullBuffer: 400 μs
99
blockReadSize: 8192
1010
workflowLocation: overview
1111
---
1212

1313
## Configuring the NeuropixelsV1e Headstage
14-
The `NeuropixelsV1eHeadstage` operator is used to configure the Neuropixels V1e Headstage; this can enable streaming of electrophysiology data from a Neuropixels 1.0 probe and orientation data from a Bno055 IMU. This is accomplished in the example workflow by leaving all of the `NeuropixelsV1eHeadstage` properties set to their default values.
14+
The `HeadstageNeuropixelsV1e` operator is used to configure the Neuropixels V1e Headstage; this can enable streaming of electrophysiology data from a Neuropixels 1.0 probe and orientation data from a Bno055 IMU. This is accomplished in the example workflow by leaving all of the `HeadstageNeuropixelsV1e` properties set to their default values.
1515

1616
Default values for the headstage are:
1717
- Enabling the first 384 electrodes for streaming (electrodes 0 through 383)
@@ -22,7 +22,7 @@ Default values for the headstage are:
2222
- Setting the `Reference` to *External*
2323

2424
> [!IMPORTANT]
25-
> The workflow will not run unless gain calibration and ADC calibration files are provided. Click the `NeuropixelsV1eHeadstage` operator, expand `NeuropixelsV1e` in the properties pane, then choose the appropriate files by selecting either `GainCalibrationFile` or `AdcCalibrationFile` and clicking the <kbd>...</kbd> button.
25+
> The workflow will not run unless gain calibration and ADC calibration files are provided. Click the `HeadstageNeuropixelsV1e` operator, expand `NeuropixelsV1e` in the properties pane, then choose the appropriate files by selecting either `GainCalibrationFile` or `AdcCalibrationFile` and clicking the <kbd>...</kbd> button.
2626
2727
> [!TIP]
2828
> For additional details on how to manually configure the headstage, such as enabling specific electrodes for recording, or modify AP / LFP gain, check out the <xref:np1e_gui> page.

articles/hardware/np1e/gui.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The `NeuropixelsV1e` headstage has a graphical user interface when the `OpenEphy
88

99
## Overview
1010

11-
For `NeuropixelsV1eHeadstage`, the GUI allows for an easy way to change settings and visualize the effect. From the GUI, you can:
11+
For `HeadstageNeuropixelsV1e`, the GUI allows for an easy way to change settings and visualize the effect. From the GUI, you can:
1212

1313
- Configure the <xref:OpenEphys.Onix1.NeuropixelsV1ProbeConfiguration>
1414
- Choose the ADC calibration file
@@ -21,7 +21,7 @@ For `NeuropixelsV1eHeadstage`, the GUI allows for an easy way to change settings
2121
- Configure the [Bno055](xref:OpenEphys.Onix1.ConfigurePolledBno055)
2222
- Enable and disable the <xref:OpenEphys.Onix1.PolledBno055Data> stream
2323

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

2626
### Channel constraints
2727

@@ -47,13 +47,13 @@ If the window is closed any other way (such as by pressing `Cancel`, or pressing
4747

4848
### ProbeInterface
4949

50-
The `NeuropixelsV1eHeadstage` GUI uses [ProbeInterface](https://probeinterface.readthedocs.io/en/main/index.html) as the format to draw the probes and electrodes visually. For more information on ProbeInterface and the resulting JSON file, check out their [format specifications](https://probeinterface.readthedocs.io/en/main/format_spec.html) page.
50+
The `HeadstageNeuropixelsV1e` GUI uses [ProbeInterface](https://probeinterface.readthedocs.io/en/main/index.html) as the format to draw the probes and electrodes visually. For more information on ProbeInterface and the resulting JSON file, check out their [format specifications](https://probeinterface.readthedocs.io/en/main/format_spec.html) page.
5151

5252
When opening the GUI, there is a default probe configuration that is loaded and drawn, which can be saved to a [JSON file](#save-probeinterface-file). Conversely, an existing JSON file can be [loaded](#load-probeinterface-file) to update the current channel configuration. If for any reason the default configuration is needed, it can be [loaded again](#load-default-configuration) at any time.
5353

5454
## Open Headstage Configuration GUI
5555

56-
To open the headstage configuration GUI, double-click the `ConfigureNeuropixelsV1eHeadstage` operator.
56+
To open the headstage configuration GUI, double-click the `ConfigureHeadstageNeuropixelsV1e` operator.
5757

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

articles/hardware/np1e/np1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The <xref:OpenEphys.Onix1.NeuropixelsV1eData> operator generates a sequence of
1717
channel x 36 sample] `SpikeData` matrix, and a [384 channel x 3 sample] `LfpData` matrix. The Neuropixels 1.0 probe
1818
samples AP data at 30 kHz per channel (LFP data is sampled at a rate of 1/12 of the rate AP data) so this corresponds
1919
to 1.2 ms of data.
20-
- `DeviceName` is set to "NeuropixelsV1eHeadstage/NeuropixelsV1e". This links the `NeuropixelsV1eData` operator to the
20+
- `DeviceName` is set to "HeadstageNeuropixelsV1e/NeuropixelsV1e". This links the `NeuropixelsV1eData` operator to the
2121
corresponding configuration operator.
2222

2323
Given the settings above, each frame will contain a [1 x 36 sample] `Clock` vector, a [384 channel x 36 sample]

articles/hardware/np1e/port-status.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ uid: np1e_port-status
33
title: NeuropixelsV1e Headstage Port Status
44
hardware: NeuropixelsV1e Headstage
55
portStatus: true
6-
configureHardwareOperator: ConfigureNeuropixelsV1eHeadstage
7-
hardwareOperator: NeuropixelsV1eHeadstage
6+
configureHardwareOperator: ConfigureHeadstageNeuropixelsV1e
7+
hardwareOperator: HeadstageNeuropixelsV1e
88
workflowLocation: overview
99
---

articles/hardware/np2e/bno055.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ title: NeuropixelsV2e Bno055
44
bno055: true
55
hardware: NeuropixelsV2e Headstage
66
bnoOperator: PolledBno055Data
7-
hardwareOperator: NeuropixelsV2eHeadstage
7+
hardwareOperator: HeadstageNeuropixelsV2e
88
workflowLocation: overview
99
---

articles/hardware/np2e/configuration.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,26 @@ uid: np2e_configuration
33
title: NeuropixelsV2e Headstage Configuration
44
hardware: NeuropixelsV2e Headstage
55
configuration: true
6-
operator: ConfigureNeuropixelsV2eHeadstage
6+
operator: ConfigureHeadstageNeuropixelsV2e
77
dataRate: 18.1
88
timeUntilFullBuffer: 440 μs
99
blockReadSize: 8192
1010
workflowLocation: overview
1111
---
1212

1313
> [!NOTE]
14-
> The NeuropixelsV2eBeta Headstage functions nearly identically to the NeuropixelsV2e Headstage. Simply replace `ConfigureNeuropixelsV2eHeadstage` with `ConfigureNeuropixelsV2eBetaHeadstage`.
14+
> The NeuropixelsV2eBeta Headstage functions nearly identically to the NeuropixelsV2e Headstage. Simply replace `ConfigureHeadstageNeuropixelsV2e` with `ConfigureHeadstageNeuropixelsV2eBeta`.
1515
1616
## Configuring the NeuropixelsV2e headstage
17-
The `NeuropixelsV2eHeadstage` operator is set to configure the NeuropixelsV2e Headstage; this can enable streaming of electrophysiology data from a Neuropixels 2.0 probe and orientation data from a Bno055 IMU. This is accomplished in the NeuropixelsV2e Headstage example workflow by leaving all of the `NeuropixelsV2eHeadstage` properties set to their default values.
17+
The `HeadstageNeuropixelsV2e` operator is set to configure the NeuropixelsV2e Headstage; this can enable streaming of electrophysiology data from a Neuropixels 2.0 probe and orientation data from a Bno055 IMU. This is accomplished in the NeuropixelsV2e Headstage example workflow by leaving all of the `HeadstageNeuropixelsV2e` properties set to their default values.
1818

1919
Default values for the headstage are:
2020
- Enabling the first 384 electrodes of the first shank for streaming (shank 0, electrodes 0 through 383)
2121
- This is also known as the **Shank 0 Bank A** `Channel Preset`
2222
- Setting the `Reference` to *External*
2323

2424
> [!IMPORTANT]
25-
> The workflow will not run unless gain correction files are provided. Click the `NeuropixelsV2eHeadstage` operator, expand `NeuropixelsV2e` in the property pane, then choose the appropriate files by selecting either `GainCalibrationFileA` or `GainCalibrationFileB` and clicking the <kbd>...</kbd> button. If only one probe is plugged in, only one file is required.
25+
> The workflow will not run unless gain correction files are provided. Click the `HeadstageNeuropixelsV2e` operator, expand `NeuropixelsV2e` in the property pane, then choose the appropriate files by selecting either `GainCalibrationFileA` or `GainCalibrationFileB` and clicking the <kbd>...</kbd> button. If only one probe is plugged in, only one file is required.
2626
2727
> [!TIP]
2828
> For additional details on how to manually configure the headstage, such as enabling specific electrodes for recording, or modify AP / LFP gain, check out the <xref:np2e_gui> page.

articles/hardware/np2e/gui.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The `NeuropixelsV2e` headstage has a graphical user interface when the `OpenEphy
1010

1111
## Overview
1212

13-
For `NeuropixelsV2eHeadstage`, the GUI allows for an easy way to change settings and visualize the effect. From the GUI, you can:
13+
For `HeadstageNeuropixelsV2e`, the GUI allows for an easy way to change settings and visualize the effect. From the GUI, you can:
1414

1515
- Configure `Probe A` and `Probe B` independently
1616
- Choose the probe calibration file
@@ -47,7 +47,7 @@ If the window is closed any other way (such as by pressing `Cancel`, or pressing
4747

4848
### ProbeInterface
4949

50-
The `NeuropixelsV2eHeadstage` GUI uses [ProbeInterface](https://probeinterface.readthedocs.io/en/main/index.html) as the format to draw the probes and electrodes visually. For more information on ProbeInterface and the resulting JSON file, check out their [format specifications](https://probeinterface.readthedocs.io/en/main/format_spec.html) page.
50+
The `HeadstageNeuropixelsV2e` GUI uses [ProbeInterface](https://probeinterface.readthedocs.io/en/main/index.html) as the format to draw the probes and electrodes visually. For more information on ProbeInterface and the resulting JSON file, check out their [format specifications](https://probeinterface.readthedocs.io/en/main/format_spec.html) page.
5151

5252
When opening the GUI, there is a default probe configuration that is loaded and drawn, which can be saved to a [JSON file](#save-probeinterface-file). Conversely, an existing JSON file can be [loaded](#load-probeinterface-file) to update the current channel configuration. If for any reason the default configuration is needed, it can be [loaded again](#load-default-configuration) at any time.
5353

@@ -56,7 +56,7 @@ When opening the GUI, there is a default probe configuration that is loaded and
5656
![Open the GUI](../../../images/neuropixelsv2e-gui-tut/bonsai-editor-where-to-click.png)
5757

5858
Steps to open the Probe Configuration GUI:
59-
- Select the `ConfigureNeuropixelsV2eHeadstage` node.
59+
- Select the `ConfigureHeadstageNeuropixelsV2e` node.
6060
- Click on the `NeuropixelsV2eProbeConfiguration` to edit (either `ProbeConfigurationA` or `ProbeConfigurationB`).
6161
- Select the <kbd>...</kbd> button on the right-most part of the property pane (#1 above).
6262

@@ -176,7 +176,7 @@ To load the default channel configuration at any time, navigate to the File drop
176176

177177
Step to open the headstage configuration GUI
178178

179-
- Double-click the `ConfigureNeuropixelsV2eHeadstage` node (#2 above)
179+
- Double-click the `ConfigureHeadstageNeuropixelsV2e` node (#2 above)
180180

181181
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).
182182

articles/hardware/np2e/np2.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ hardware: NeuropixelsV2e Headstage
77
> [!NOTE]
88
> The NeuropixelsV2eBeta Headstage functions nearly identically to the NeuropixelsV2e Headstage. Simply replace
99
> `NeuropixelsV2eData` with `NeuropixelsV2eBetaData` and set its `DeviceName` property to
10-
> "NeuropixelsV2eBetaHeadstage/NeuropixelsV2eBeta".
10+
> "HeadstageNeuropixelsV2eBeta/NeuropixelsV2eBeta".
1111
1212
The following excerpt from the NeuropixelsV2e Headstage [example workflow](xref:np2e) demonstrates Neuropixels 2.0 probe
1313
functionality by streaming data and saves Neuropixels 2.0 probe data. The second chain is disabled by default, assuming
@@ -24,7 +24,7 @@ The <xref:OpenEphys.Onix1.NeuropixelsV2eData> operator generates a sequence of
2424
- `BufferSize` is set to 30. Therefore, each frame will contain a [1 x 30 sample] `Clock` vector and a [384 channel x 30
2525
sample] `AmplifierData` matrix. The Neuropixels 2.0 probe samples at 30 kHz per channel so this corresponds to 1 ms of
2626
data.
27-
- `DeviceName` is set to "NeuropixelsV2eHeadstage/NeuropixelsV2e". This links the `NeuropixelsV2eData` operator to the
27+
- `DeviceName` is set to "HeadstageNeuropixelsV2e/NeuropixelsV2e". This links the `NeuropixelsV2eData` operator to the
2828
corresponding configuration operator.
2929
- `ProbeIndex` is set to "ProbeA". This links the data generated by this probe to the probe in port A of the headstage.
3030

0 commit comments

Comments
 (0)