Contributions:NeuroscanADC - Revision history

Mellinger: /* Location */

2011-04-26T16:48:38Z

Location

← Older revision		Revision as of 16:48, 26 April 2011
Line 5:		Line 5:
	http://{{SERVERNAME}}/svn/trunk/src/contrib/SignalSource/Neuroscan		http://{{SERVERNAME}}/svn/trunk/src/contrib/SignalSource/Neuroscan

	In recent versions of BCI2000, the executable for this source module is called ''NeuroscanClient''.		In recent versions of BCI2000, the executable for this source module is called ''NeuroscanClient''. Earlier, it was called ''Neuroscan''.

	==Versioning==		==Versioning==

Mellinger at 16:42, 26 April 2011

2011-04-26T16:42:39Z

← Older revision		Revision as of 16:42, 26 April 2011
Line 25:		Line 25:
	environments created the need for Neuroscan support in BCI2000. This page		environments created the need for Neuroscan support in BCI2000. This page
	describes this support that consists of two components: A BCI2000-compatible		describes this support that consists of two components: A BCI2000-compatible
	Source Module (<tt>~~Neuroscan~~.exe</tt>) and a command-line tool		Source Module (<tt>NeuroscanClient.exe</tt>) and a command-line tool
	(<tt>neurogetparams</tt>). These components are described below and have been		(<tt>neurogetparams</tt>). These components are described below and have been
	tested with '''Neuroscan Acquire''' version 4.3.1.		tested with '''Neuroscan Acquire''' version 4.3.1.

	===Neuroscan Source Module===		===Neuroscan Source Module===
	The BCI2000-compatible Source Module <tt>~~Neuroscan~~.exe</tt> can be used instead		The BCI2000-compatible Source Module <tt>NeuroscanClient.exe</tt> can be used instead
	of any other source module. In addition to standard parameters (i.e.		of any other source module. In addition to standard parameters (i.e.
	''SampleBlockSize,'' ''SamplingRate,'' ''SourceCh''), it only		''SampleBlockSize,'' ''SamplingRate,'' ''SourceCh''), it only

Mellinger: /* Location */

2011-04-26T15:30:13Z

Location

← Older revision		Revision as of 15:30, 26 April 2011
Line 4:		Line 4:
	==Location==		==Location==
	http://{{SERVERNAME}}/svn/trunk/src/contrib/SignalSource/Neuroscan		http://{{SERVERNAME}}/svn/trunk/src/contrib/SignalSource/Neuroscan

			In recent versions of BCI2000, the executable for this source module is called ''NeuroscanClient''.

	==Versioning==		==Versioning==

Mellinger: /* Functional Description */

2009-06-04T11:06:44Z

Functional Description

← Older revision		Revision as of 11:06, 4 June 2009
Line 21:		Line 21:
	'''NuAmps/SynAmps''' are EEG recording systems from Neuroscan, Inc., that are		'''NuAmps/SynAmps''' are EEG recording systems from Neuroscan, Inc., that are
	widely used in clinical settings. The increasing use of BCI2000 in those		widely used in clinical settings. The increasing use of BCI2000 in those
	environments created the need for Neuroscan support in BCI2000. This ~~document~~		environments created the need for Neuroscan support in BCI2000. This page
	describes this support that consists of two components: A BCI2000-compatible		describes this support that consists of two components: A BCI2000-compatible
	Source Module (<tt>Neuroscan.exe</tt>) and a command-line tool		Source Module (<tt>Neuroscan.exe</tt>) and a command-line tool

Mellinger: /* The `neurogetparams` Command Line Tool */

2007-12-13T17:04:22Z

The <tt>neurogetparams</tt> Command Line Tool

← Older revision		Revision as of 17:04, 13 December 2007
Line 140:		Line 140:
	Parameter file test.prm successfully written		Parameter file test.prm successfully written
	</pre>		</pre>

			==See also==
			[[User Reference:Filters]], [[Contributions:ADCs]]

			[[Category:Contributions]][[Category:Data Acquisition]]

Mellinger at 16:13, 13 December 2007

2007-12-13T16:13:17Z

New page

==Synopsis==
The ''NeuroscanADC'' component implements the client side of the TCP/IP-based Neuroscan Acquire protocol. Thus, it may be used to interface BCI2000 with Neuroscan EEG systems.

==Location==
http://{{SERVERNAME}}/svn/trunk/src/contrib/SignalSource/Neuroscan

==Versioning==
===Author===
Gerwin Schalk, (c) 2004 Wadsworth Center, New York State Department of Health.

===Version History===
* V1.00 - 04/28/2004 - First working version
* V1.10 - 05/17/2004 - Now includes support for 32bit data
===Source Code Revisions===
*Initial development: 268
*Tested under: 1110
*Known to compile under: 1528
*Broken since: --

==Functional Description==
'''NuAmps/SynAmps''' are EEG recording systems from Neuroscan, Inc., that are
widely used in clinical settings. The increasing use of BCI2000 in those
environments created the need for Neuroscan support in BCI2000. This document
describes this support that consists of two components: A BCI2000-compatible
Source Module (<tt>Neuroscan.exe</tt>) and a command-line tool
(<tt>neurogetparams</tt>). These components are described below and have been
tested with '''Neuroscan Acquire''' version 4.3.1.

===Neuroscan Source Module===
The BCI2000-compatible Source Module <tt>Neuroscan.exe</tt> can be used instead
of any other source module. In addition to standard parameters (i.e.
''SampleBlockSize,'' ''SamplingRate,'' ''SourceCh''), it only
requests one Neuroscan-specific parameter ''(ServerAddress)'' that defines
the IP address (or host name) and the port number of the ''Acquire'' server.
An example for an appropriate definition is <tt>localhost:3999</tt>. Before
starting BCI2000, you need to start '''Acquire,''' click on the '''S''' symbol
in the top right corner (to enable the server) and start the server on any port.
Please note that by default, '''Acquire''' suggests port 4000, which is a port
used by BCI2000. You might use port 3999 instead. Once the server is running,
you can start BCI2000. It is imperative that certain parameters (e.g., the
number of channels) in BCI2000 match the settings in '''Acquire.''' You can
read these settings from '''Acquire''' using the command line tool described in
the following section. This command line tool can create a parameter file
fragment that needs to be loaded on top of an existing parameter file every time
a setting in '''Acquire''' is changed.

===Undocumented Communication===
'''Neuroscan Acquire''' supports communication options that are not documented
in the <tt>NetAcquire.doc</tt> document. BCI2000 needs to use two of them, the
request for basic Neuroscan configuration information (which will return
information such as the number of channels and the sampling rate) and the
receipt of packets of data, to function properly. They are listed below:
{| border="1"
! Packet ID !! Code !! Request !! Body Size
|-
| "CTRL" || 3 (Client Ctrl Code) || 5 (Req Basic Info) || 0
|-
| "DATA" || 1 (Datatype Info) || 3 (InfoType BasicInfo) || bodyLen
|-
| "DATA" || 2 (EEG Data) || 1 (Raw 16-bit) || bodyLen
|}

====Request Basic Information====
The client sends a request for basic information ("CTRL", Client Ctrl Code, Req
Basic Info). The server responds by sending a data block ("DATA", Datatype Info,
InfoType BasicInfo) that contains a data structure describing the current
configuration of data acquisition in Acquire. This data structure is as follows:

<pre>
struct AcqBasicInfo
{
DWORD dwSize; // Size of structure, used for version control
int nEegChan; // Number of EEG channels
int nEvtChan; // Number of event channels
int nBlockPnts; // Samples in block
int nRate; // Sampling rate (in Hz)
int nDataSize; // 2 for "short", 4 for "int" type of data
float fResolution; // Resolution for LSB
};
</pre>

The first element, dwSize, can and should be cross checked with the length of
the structure '''AcqBasicInfo''' and must match.

====Receive 16-bit Data Packet====
The client may send a '''Request to Start Sending Data''' to the Acquire server
(as described in the <tt>NetAcquire.doc</tt> document). This will prompt the
server to start sending blocks of raw signal values. In order to interpret these
signal values, the client must first have sent a '''Request for Basic Information,''' as described above. The incoming data packets ("DATA", EEG Data,
Raw 16-bit) can then be interpreted using this information and the code below.

<pre>
// make sure the body has the right length
assert((int)(pMsg->m_dwSize) ==
(int)(m_BasicInfo.nEegChan+m_BasicInfo.nEvtChan)
*m_BasicInfo.nBlockPnts*m_BasicInfo.nDataSize);
// process raw 16 bit data
for (int samp=0; samp<m_BasicInfo.nBlockPnts; samp++)
{
for (int ch=0; ch<m_BasicInfo.nEegChan+m_BasicInfo.nEvtChan; ch++)
{
short *sample=(short *)pMsg->m_pBody;
printf("%d ", sample[samp*(m_BasicInfo.nEegChan+m_BasicInfo.nEvtChan)+ch]);
}
}
</pre>

==Parameters==
===ServerAddress===
Address and port of the Neuroscan Acquire server, given in <tt>address:port</tt> format.

==States==
===NeuroscanEvent1===
An 8-bit state that encodes event information as sent over the Neuroscan Acquire protocol.

==The <tt>neurogetparams</tt> Command Line Tool==
This command line tool reads system settings from the '''Neuroscan Acquire'''
server, displays them on a screen and creates a BCI2000 parameter file fragment
if desired. It can be used as follows: <tt>neurogetparams -address
localhost:3999 -paramfile test.prm</tt>. (The '''Acquire''' server has to be
enabled before using this tool.) Once BCI2000 is configured correctly, this
parameter file fragment needs to be loaded on top of the existing configuration
to make sure that the settings match. You only need to repeat this procedure if
you change settings in '''Acquire''' (e.g., such as the number of channels or
the amplification).

<pre>
BCI2000 Parameter Tool for Neuroscan Acquire V4.3
*******************************************************************
(C)2004 Gerwin Schalk and Juergen Mellinger
Wadsworth Center, New York State Dept of Health, Albany, NY
Eberhardt-Karls University of Tuebingen, Germany
*******************************************************************
Signal Channels: 32
Event Channels: 1
Block Size: 40
Sampling Rate: 1000
Bits/Sample: 16
Resolution: 0.168uV/LSB
Parameter file test.prm successfully written
</pre>

Contributions:NeuroscanADC - Revision history

Mellinger: /* Location */

Mellinger at 16:42, 26 April 2011

Mellinger: /* Location */

Mellinger: /* Functional Description */

Mellinger: /* The neurogetparams Command Line Tool */

Mellinger at 16:13, 13 December 2007

Mellinger: /* The `neurogetparams` Command Line Tool */