Programming Tutorial:Working with the FieldTrip buffer - Revision history

Abelsten at 18:18, 14 June 2019

2019-06-14T18:18:54Z

← Older revision		Revision as of 18:18, 14 June 2019
Line 17:		Line 17:

	% read the header for the first time to determine number of channels and sampling rate		% read the header for the first time to determine number of channels and sampling rate
	hdr = ~~read_header~~(filename, 'cache', true);		hdr = ft_read_header(filename, 'cache', true);

	count = 0;		count = 0;
Line 26:		Line 26:
	while true		while true
	% determine number of samples available in buffer		% determine number of samples available in buffer
	hdr = ~~read_header~~(filename, 'cache', true);		hdr = ft_read_header(filename, 'cache', true);

	% see whether new samples are available		% see whether new samples are available
Line 43:		Line 43:

	% read data segment from buffer		% read data segment from buffer
	dat = ~~read_data~~(filename, 'header', hdr, 'begsample', begsample, 'endsample', endsample, 'chanindx', chanindx);		dat = ft_read_data(filename, 'header', hdr, 'begsample', begsample, 'endsample', endsample, 'chanindx', chanindx);

	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%		%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

Mellinger: /* Closing the loop, writing a control signal from Matlab to BCI2000 */

2012-07-02T15:52:00Z

Closing the loop, writing a control signal from Matlab to BCI2000

← Older revision		Revision as of 15:52, 2 July 2012
Line 70:		Line 70:

	<pre>		<pre>
	~~event_up~~.type = 'Signal';		event.type = 'Signal';
			event.sample = 1;
			event.offset = 0;
			event.duration = 1;
			</pre>

			<pre>
			event_up = event;
	event_up.value = 1;		event_up.value = 1;
	</pre>		</pre>

	<pre>		<pre>
	event_down~~.type~~ = ~~'Signal'~~;		event_down = event;
	event_down.value = -1;		event_down.value = -1;
	</pre>		</pre>

	<pre>		<pre>
	event_null~~.type~~ = ~~'Signal'~~;		event_null = event;
	event_null.value = 0;		event_null.value = 0;
	</pre>		</pre>
Line 89:		Line 96:
	filename = 'buffer://localhost:1972';		filename = 'buffer://localhost:1972';

	~~write_event~~(filename, event_up); % ... the cursor will move up ...		ft_write_event(filename, event_up); % ... the cursor will move up ...

	~~write_event~~(filename, event_down); % ... the cursor will move down ...		ft_write_event(filename, event_down); % ... the cursor will move down ...

	~~write_event~~(filename, event_null); % ... the cursor will stay at a constant value ...		ft_write_event(filename, event_null); % ... the cursor will stay at a constant value ...
	</pre>		</pre>

Gschalk: /* Getting the data in Matlab */

2008-12-03T11:44:00Z

Getting the data in Matlab

← Older revision		Revision as of 11:44, 3 December 2008
Line 11:		Line 11:
	To use the FieldTrip buffer, you start BCI2000 with the FieldTripBuffer as the Signal Processing application. Subsequently you start MATLAB yourself, i.e. your MATLAB session is a normal standalone application. You should have a recent copy of the FieldTrip toolbox installed, or at least a copy of the FieldTrip fileio module. The FieldTrip toolbox and its components are available for download from http://www.ru.nl/neuroimaging/fieldtrip. Please make sure that the correct version of the fileio module is on your MATLAB search path.		To use the FieldTrip buffer, you start BCI2000 with the FieldTripBuffer as the Signal Processing application. Subsequently you start MATLAB yourself, i.e. your MATLAB session is a normal standalone application. You should have a recent copy of the FieldTrip toolbox installed, or at least a copy of the FieldTrip fileio module. The FieldTrip toolbox and its components are available for download from http://www.ru.nl/neuroimaging/fieldtrip. Please make sure that the correct version of the fileio module is on your MATLAB search path.

	Subsequently you can do something like the following code ~~belos~~. You should be able to copy and paste the code into the MATLAB command window and get a real-time updating MATLAB figure with the data from BCI2000.		Subsequently you can do something like the following code below. You should be able to copy and paste the code into the MATLAB command window and get a real-time updating MATLAB figure with the data from BCI2000.

	<pre>		<pre>

Gschalk: /* Closing the loop, writing a control signal from Matlab to BCI2000 */

2008-12-03T11:43:40Z

Closing the loop, writing a control signal from Matlab to BCI2000

← Older revision		Revision as of 11:43, 3 December 2008
Line 67:		Line 67:
	==Closing the loop, writing a control signal from Matlab to BCI2000==		==Closing the loop, writing a control signal from Matlab to BCI2000==

	To close the loop, you have to write ~~teh~~ control signal back to BCI2000. Since the FieldTrip buffer can only hold raw data, the control signal cannot be written as data. Instead, the control signal is written as an event. This is easily demonstrated if you run the Feedback Demo Task.		To close the loop, you have to write the control signal back to BCI2000. Since the FieldTrip buffer can only hold raw data, the control signal cannot be written as data. Instead, the control signal is written as an event. This is easily demonstrated if you run the Feedback Demo Task.

	<pre>		<pre>

Roostenveld: /* Getting the data in Matlab */

2008-12-02T15:52:07Z

Getting the data in Matlab

← Older revision		Revision as of 15:52, 2 December 2008
Line 11:		Line 11:
	To use the FieldTrip buffer, you start BCI2000 with the FieldTripBuffer as the Signal Processing application. Subsequently you start MATLAB yourself, i.e. your MATLAB session is a normal standalone application. You should have a recent copy of the FieldTrip toolbox installed, or at least a copy of the FieldTrip fileio module. The FieldTrip toolbox and its components are available for download from http://www.ru.nl/neuroimaging/fieldtrip. Please make sure that the correct version of the fileio module is on your MATLAB search path.		To use the FieldTrip buffer, you start BCI2000 with the FieldTripBuffer as the Signal Processing application. Subsequently you start MATLAB yourself, i.e. your MATLAB session is a normal standalone application. You should have a recent copy of the FieldTrip toolbox installed, or at least a copy of the FieldTrip fileio module. The FieldTrip toolbox and its components are available for download from http://www.ru.nl/neuroimaging/fieldtrip. Please make sure that the correct version of the fileio module is on your MATLAB search path.

	Subsequently you can do something like ~~this~~		Subsequently you can do something like the following code belos. You should be able to copy and paste the code into the MATLAB command window and get a real-time updating MATLAB figure with the data from BCI2000.

	<pre>		<pre>

Roostenveld at 15:50, 2 December 2008

2008-12-02T15:50:41Z

← Older revision		Revision as of 15:50, 2 December 2008
Line 1:		Line 1:
			One of the user-contributed Signal Processing filters is the <em>FieldTripBuffer</em>. The FieldTripBuffer allows you to use BCI2000 in conjunction with MATLAB, just as with the <em>MatlabFilter</em>. The difference between the two interfaces to MATLAB is that the MatlabFilter causes some MATLAB code to be executed in the BCI2000 pipeline, i.e. BCI2000 stays in control over the timing and the MATLAB session only sees a small fragment of the data. That also forces you to write your MATLAB code to use recursive/incremental updating schemes. The FieldTripBuffer interface to MATLAB allows you to control the timing from within MATLAB and read arbitrary sections of data from the ongoing data stream as if it were a continuously growing file, giving more flexibility in the MATLAB code that you can employ.

			The advantage of the FieldTripBuffer interface is that you have all control in MATLAB that you are used to. You can write your MATLAB code for offline-analysis (i.e. reading data from a file) and apply exactly the same code to online analysis (i.e. reading from BCI2000). Of course for the online analysis to make some sense, your analysis script has to be meaningful and has to work with relatively small data fragments (e.g. one second or less), otherwise the MATLAB code would not really run in real-time. Another interesting feature is that in MATLAB you can use the profiler (type "help profile") to determine which parts of your code take a long time to execute and speed those parts up.

			The remainder of this page gives an example of how to get the data into MATLAB, plot the data using standard MATLAB code, and how to close the BCI loop by writing an event back to BCI2000. The example below does not do any useful processing, it is up to you to decide how you want to process the data in MATLAB. A number of realtime applications are included in the realtime module of the FieldTrip toolbox. Additional documentation for that can be found on the FieldTrip website, under <em>development->realtime</em>.

	==Getting the data in Matlab==		==Getting the data in Matlab==

Roostenveld: /* Closing the loop, writing a control signal from Matlab to BCI2000 */

2008-12-02T15:34:29Z

Closing the loop, writing a control signal from Matlab to BCI2000

← Older revision		Revision as of 15:34, 2 December 2008
Line 83:		Line 83:
	filename = 'buffer://localhost:1972';		filename = 'buffer://localhost:1972';

	write_event(filename, event_up);		write_event(filename, event_up); % ... the cursor will move up ...

	% ... the cursor will move up ...		write_event(filename, event_down); % ... the cursor will move down ...

	~~write_event(filename, event_down);~~		write_event(filename, event_null); % ... the cursor will stay at a constant value ...

	~~% ... the cursor will move down ...~~

	write_event(filename, event_null);

	% ... the cursor will stay at a constant value ...
	</pre>		</pre>

Roostenveld: /* Getting the data in Matlab */

2008-12-02T15:26:34Z

Getting the data in Matlab

← Older revision		Revision as of 15:26, 2 December 2008
Line 3:		Line 3:
	The FieldTrip buffer is a multi-threaded and network transparent buffer that allows data to be streamed to it by BCI2000, while at the same time allowing a seperate MATLAB session on the same or another computer to read data from the buffer for analysis. Besides writing the data, BCI2000 also writes the changed status variables as events.		The FieldTrip buffer is a multi-threaded and network transparent buffer that allows data to be streamed to it by BCI2000, while at the same time allowing a seperate MATLAB session on the same or another computer to read data from the buffer for analysis. Besides writing the data, BCI2000 also writes the changed status variables as events.

	To use the FieldTrip buffer, you start BCI2000 with the FieldTripBuffer as the Signal Processing application. Subsequently you start MATLAB yourself, i.e. your MATLAB session is a normal standalone application.		To use the FieldTrip buffer, you start BCI2000 with the FieldTripBuffer as the Signal Processing application. Subsequently you start MATLAB yourself, i.e. your MATLAB session is a normal standalone application. You should have a recent copy of the FieldTrip toolbox installed, or at least a copy of the FieldTrip fileio module. The FieldTrip toolbox and its components are available for download from http://www.ru.nl/neuroimaging/fieldtrip. Please make sure that the correct version of the fileio module is on your MATLAB search path.

	~~To read from the FieldTrip buffer, you should have a copy of the FieldTrip toolbox, or at least a copy of the FieldTrip fileio module.~~ Subsequently you can do something like this		Subsequently you can do something like this

	<pre>		<pre>

Roostenveld: /* Getting the data in Matlab */

2008-12-02T15:07:24Z

Getting the data in Matlab

← Older revision		Revision as of 15:07, 2 December 2008
Line 2:		Line 2:

	The FieldTrip buffer is a multi-threaded and network transparent buffer that allows data to be streamed to it by BCI2000, while at the same time allowing a seperate MATLAB session on the same or another computer to read data from the buffer for analysis. Besides writing the data, BCI2000 also writes the changed status variables as events.		The FieldTrip buffer is a multi-threaded and network transparent buffer that allows data to be streamed to it by BCI2000, while at the same time allowing a seperate MATLAB session on the same or another computer to read data from the buffer for analysis. Besides writing the data, BCI2000 also writes the changed status variables as events.

			To use the FieldTrip buffer, you start BCI2000 with the FieldTripBuffer as the Signal Processing application. Subsequently you start MATLAB yourself, i.e. your MATLAB session is a normal standalone application.

	To read from the FieldTrip buffer, you should have a copy of the FieldTrip toolbox, or at least a copy of the FieldTrip fileio module. Subsequently you can do something like this		To read from the FieldTrip buffer, you should have a copy of the FieldTrip toolbox, or at least a copy of the FieldTrip fileio module. Subsequently you can do something like this

Roostenveld: /* Getting the data in Matlab */

2008-12-02T14:56:01Z

Getting the data in Matlab

← Older revision		Revision as of 14:56, 2 December 2008
Line 6:		Line 6:

	<pre>		<pre>
			filename = 'buffer://localhost:1972';

	% read the header for the first time to determine number of channels and sampling rate		% read the header for the first time to determine number of channels and sampling rate
	hdr = read_header(filename, 'cache', true);		hdr = read_header(filename, 'cache', true);