You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/tutorials/ephys-socket.md
+35-32Lines changed: 35 additions & 32 deletions
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ title: Visualizing Data in the Open Ephys GUI
4
4
---
5
5
6
6
This tutorial shows how to stream ephys data from Bonsai the Open Ephys
7
-
GUIthrough an intermediary TCP connection. This approach lets users take
7
+
GUI through an intermediary TCP connection. This approach lets users take
8
8
advantage of both the extensibility of Bonsai and specialized visualizers
9
9
available in the Open Ephys GUI such as the Probe Viewer which is specifically
10
10
designed for very dense arrays like Neuropixels probes. By the end of this
@@ -13,24 +13,16 @@ NeuropixelsV1e headstage (384 channels of LFP band and AP band data) and an Open
13
13
Ephys GUI signal chain that receives and visualizes the two data streams in the
14
14
Open Ephys GUI:
15
15
16
-

17
-
18
-
Click <ahref="../../workflows/tutorials/ephys-socket/sockets-signal-chain"download>here</a> to
19
-
download the signal chain that corresponds to the above graph.
16
+

20
17
21
18
> [!NOTE]
22
-
> This tutorial uses NeuropixelsV1e Headstage as an example, but the process is
23
-
> similar for other ephys headstages. In fact, this tutorial can be used to send
24
-
> data from any Bonsai operator that produces an applies to any data source that
25
-
> produces matrices (`OpenCV.NET.Mat`s).
26
-
>
27
-
> This tutorial assumes you are familiar with the [hardware
28
-
> guide](xref:hardware) of the ONIX headstage you intend to use. Use the
29
-
> information on the <xref:data-elements> reference page to know which shift and
30
-
> scaling you need to use for each device on other headstages.
31
-
>
32
-
> A [video summary](#video-summary) of this tutorial is is available at the
33
-
> bottom of this page.
19
+
> - This tutorial uses NeuropixelsV1e Headstage as an example, but the process is
20
+
> similar for other ephys headstages. In fact, this tutorial can be used to send
21
+
> data from any Bonsai operator that produces [matrices](xref:OpenCV.Net.Mat).
22
+
> - This tutorial assumes you are familiar with the [hardware guide](xref:hardware)
23
+
> of the ONIX headstage you intend to use.
24
+
> - A [video summary](#video-summary) of this tutorial is is available at the
25
+
> bottom of this page.
34
26
35
27
## Transmit Ephys Data to a TCP Server in Bonsai
36
28
@@ -39,8 +31,8 @@ familiarize yourself with Bonsai. In particular, [download the necessary Bonsai
39
31
packages](xref:install-configure-bonsai#package-installation) or [check for
40
32
updates](xref:install-configure-bonsai#update-packages) if they're already
41
33
installed. Once you've done that, copy/paste the following workflow into your
42
-
Bonsai editor. The following sections explain how to configure each element of
43
-
this workflow
34
+
Bonsai editor. The following sections explain how to create this workflow and
35
+
configure its elements.
44
36
45
37
::: workflow
46
38

@@ -54,12 +46,11 @@ set their properties:
54
46

55
47
56
48
-**Address**: Use "localhost" if you are running Bonsai and the Open Ephys GUI
57
-
on the same machine or the IP address of the machine running the GUI if not.
58
-
-**Name**: give the TCP server a unique name. We will use this name to provide
59
-
later in the workflow to send data though the connections established by this
60
-
server. In this example, we have named them "SpikeServer" and "LfpServer".
61
-
These names are arbitrary, but in our example they correspond to the kind of
62
-
data they will transmit.
49
+
on the same machine. Use the IP address of the machine running the GUI if not.
50
+
-**Name**: give the TCP server a unique name. This name is used later in the
51
+
the workflow to specify to which server to send data. In this example, we have
52
+
named them "SpikeServer" and "LfpServer". These names are arbitrary, but in
53
+
our example they correspond to the kind of data they will transmit.
63
54
-**Port**: choose a unique [port
64
55
number](https://en.wikipedia.org/wiki/List_of_TCP_and_UDP_port_numbers). We
65
56
will use this port number to establish the connection with the Open Ephys GUI.
@@ -127,17 +118,17 @@ streams. This operator comes from the OpenEphys.Sockets Bonsai package.
127
118

128
119
:::
129
120
130
-
Configure the "Connection" property of each `SendMatOverSocket` operator to each
131
-
of the TCP Socket names configured earlier. In this example, we used
132
-
"SpikeServer" for "SpikeData" and "LfpServer" for "LfPData".
121
+
Set the "Connection" property of each `SendMatOverSocket` operator to the name
122
+
of a TCP Socket configured earlier. In this example, "SpikeServer" is used
123
+
for "SpikeData" and "LfpServer" for "LfPData".
133
124
134
125
> [!TIP]
135
126
> Although the Open Ephys GUI has recording functionality, data acquired using
136
127
> the Bonsai.Onix1 package should be written to disk in Bonsai because it is
137
-
> possible for data to be lost if e.g. the TCP Buffer overflows. You can learn
128
+
> possible for data to be lost e.g. if the TCP Buffer overflows. You can learn
138
129
> to do this by following the [Hardware Guides](xref:hardware) for your
139
-
> particular hardware. For this example, if you are using the NeuropixelsV1e
140
-
> Headstage like the example, follow the [NeuropixelsV1e Headstage Hardware
130
+
> particular hardware. For example, if you are using the NeuropixelsV1e
131
+
> Headstage like the example, you would follow the [NeuropixelsV1e Headstage Hardware
141
132
> Guide](xref:np1e).
142
133
143
134
## Receive ONIX Data from Socket in Open Ephys GUI
@@ -156,6 +147,12 @@ get familiarized with the Open Ephys GUI. In particular:
0 commit comments