User Reference:Matlab Tools - Revision history

Jhill at 17:10, 22 March 2012

2012-03-22T17:10:47Z

← Older revision		Revision as of 17:10, 22 March 2012
Line 6:		Line 6:
	>> help bci2000chain		>> help bci2000chain

	Note that most of the Matlab functions here require the [[User_Reference:Matlab_MEX_Files\|BCI2000 mex files]] as a dependency.		Note that most of the Matlab functions here require the [[User_Reference:Matlab_MEX_Files\|BCI2000 mex files]] as a dependency. In addition, <tt>bci2000chain</tt> requires binaries of the [[User_Reference:Command_Line_Processing\|BCI2000 command-line tools]].

Jhill at 00:57, 17 March 2012

2012-03-17T00:57:14Z

← Older revision		Revision as of 00:57, 17 March 2012
Line 59:		Line 59:

	This utility allows you to read, combine, and write BCI2000 parameters from multiple sources, making use of <tt>read_bciprm</tt>.		This utility allows you to read, combine, and write BCI2000 parameters from multiple sources, making use of <tt>read_bciprm</tt>.

			==decode_bcitime==

			This function takes a BCI2000 parameter value that is supposed to indicate time, and figures out whether it is expressed in seconds/milliseconds/microseconds with an explicit PhysicalUnit, or in sexagesimal notation (e.g. MM:SS), or whether it is a bare number indicating a number of SampleBlocks. In all cases the value is returned, unambiguously, in seconds.

	==read_bcidate==		==read_bcidate==

Jhill: /* bci2000path */

2012-03-12T21:31:51Z

bci2000path

← Older revision		Revision as of 21:31, 12 March 2012
Line 19:		Line 19:
	* remove directories from the path again, or even remove everything BCI2000-related from the Matlab and system paths in one go.		* remove directories from the path again, or even remove everything BCI2000-related from the Matlab and system paths in one go.

	Of course, before you can call <tt>bci2000path</tt>, Matlab needs to know where <tt>bci2000path</tt> itself is. This chicken-and-egg problem is typical of Matlab path-juggling. You could use the graphical <tt>pathtool</tt> to add an absolute reference to the <tt>tools/matlab</tt> directory "permanently" to the Matlab path, but anyone who has made heavy use of Matlab for some time, and is in the habit of using more than one third-party toolbox, will know that this leads to problems sooner or later. One ~~way~~ is to adapt the following lines and put them either in your <tt>startup.m</tt> file, or in some other handy function in the <tt>My Documents\MATLAB</tt> (or <tt>$HOME/matlab</tt>) directory so that you can call it when needed:		Of course, before you can call <tt>bci2000path</tt>, Matlab needs to know where <tt>bci2000path</tt> itself is. This chicken-and-egg problem is typical of Matlab path-juggling. You could use the graphical <tt>pathtool</tt> to add an absolute reference to the <tt>tools/matlab</tt> directory "permanently" to the Matlab path, but anyone who has made heavy use of Matlab for some time, and is in the habit of using more than one third-party toolbox, will know that this leads to problems sooner or later. So we do not recommend the path GUI. One solution is to adapt the following lines and put them either in your <tt>startup.m</tt> file, or in some other handy function in the <tt>My Documents\MATLAB</tt> (or <tt>$HOME/matlab</tt>) directory so that you can call it when needed:

	olddir = pwd;		olddir = pwd;

Jhill: /* bci2000path */

2012-03-12T21:28:58Z

bci2000path

← Older revision		Revision as of 21:28, 12 March 2012
Line 21:		Line 21:
	Of course, before you can call <tt>bci2000path</tt>, Matlab needs to know where <tt>bci2000path</tt> itself is. This chicken-and-egg problem is typical of Matlab path-juggling. You could use the graphical <tt>pathtool</tt> to add an absolute reference to the <tt>tools/matlab</tt> directory "permanently" to the Matlab path, but anyone who has made heavy use of Matlab for some time, and is in the habit of using more than one third-party toolbox, will know that this leads to problems sooner or later. One way is to adapt the following lines and put them either in your <tt>startup.m</tt> file, or in some other handy function in the <tt>My Documents\MATLAB</tt> (or <tt>$HOME/matlab</tt>) directory so that you can call it when needed:		Of course, before you can call <tt>bci2000path</tt>, Matlab needs to know where <tt>bci2000path</tt> itself is. This chicken-and-egg problem is typical of Matlab path-juggling. You could use the graphical <tt>pathtool</tt> to add an absolute reference to the <tt>tools/matlab</tt> directory "permanently" to the Matlab path, but anyone who has made heavy use of Matlab for some time, and is in the habit of using more than one third-party toolbox, will know that this leads to problems sooner or later. One way is to adapt the following lines and put them either in your <tt>startup.m</tt> file, or in some other handy function in the <tt>My Documents\MATLAB</tt> (or <tt>$HOME/matlab</tt>) directory so that you can call it when needed:

	~~function SetupBCI2000Paths~~
	olddir = pwd;		olddir = pwd;
	cd('C:\BCI2000') % The absolute path has to be hardcoded somewhere, and here it is. Watch out, in case this is (or becomes) incorrect		cd('C:\BCI2000') % The absolute path has to be hardcoded somewhere, and here it is. Watch out, in case this is (or becomes) incorrect
Line 29:		Line 28:
	bci2000path -AddToSystemPath tools/cmdline % required so that BCI2000CHAIN can call the command-line tools		bci2000path -AddToSystemPath tools/cmdline % required so that BCI2000CHAIN can call the command-line tools
	cd(olddir) % change directory back to where we were before		cd(olddir) % change directory back to where we were before
			clear olddir

	==bci2000chain==		==bci2000chain==

Jhill: /* bci2000path */

2012-03-12T21:28:20Z

bci2000path

← Older revision		Revision as of 21:28, 12 March 2012
Line 21:		Line 21:
	Of course, before you can call <tt>bci2000path</tt>, Matlab needs to know where <tt>bci2000path</tt> itself is. This chicken-and-egg problem is typical of Matlab path-juggling. You could use the graphical <tt>pathtool</tt> to add an absolute reference to the <tt>tools/matlab</tt> directory "permanently" to the Matlab path, but anyone who has made heavy use of Matlab for some time, and is in the habit of using more than one third-party toolbox, will know that this leads to problems sooner or later. One way is to adapt the following lines and put them either in your <tt>startup.m</tt> file, or in some other handy function in the <tt>My Documents\MATLAB</tt> (or <tt>$HOME/matlab</tt>) directory so that you can call it when needed:		Of course, before you can call <tt>bci2000path</tt>, Matlab needs to know where <tt>bci2000path</tt> itself is. This chicken-and-egg problem is typical of Matlab path-juggling. You could use the graphical <tt>pathtool</tt> to add an absolute reference to the <tt>tools/matlab</tt> directory "permanently" to the Matlab path, but anyone who has made heavy use of Matlab for some time, and is in the habit of using more than one third-party toolbox, will know that this leads to problems sooner or later. One way is to adapt the following lines and put them either in your <tt>startup.m</tt> file, or in some other handy function in the <tt>My Documents\MATLAB</tt> (or <tt>$HOME/matlab</tt>) directory so that you can call it when needed:

	function SetupBCI2000Paths		function SetupBCI2000Paths
	olddir = pwd;		olddir = pwd;
	cd('C:\BCI2000') % The absolute path has to be hardcoded somewhere, and here it is. Watch out, in case this is (or becomes) incorrect		cd('C:\BCI2000') % The absolute path has to be hardcoded somewhere, and here it is. Watch out, in case this is (or becomes) incorrect

Jhill: /* bci2000path */

2012-03-12T21:28:10Z

bci2000path

← Older revision		Revision as of 21:28, 12 March 2012
Line 21:		Line 21:
	Of course, before you can call <tt>bci2000path</tt>, Matlab needs to know where <tt>bci2000path</tt> itself is. This chicken-and-egg problem is typical of Matlab path-juggling. You could use the graphical <tt>pathtool</tt> to add an absolute reference to the <tt>tools/matlab</tt> directory "permanently" to the Matlab path, but anyone who has made heavy use of Matlab for some time, and is in the habit of using more than one third-party toolbox, will know that this leads to problems sooner or later. One way is to adapt the following lines and put them either in your <tt>startup.m</tt> file, or in some other handy function in the <tt>My Documents\MATLAB</tt> (or <tt>$HOME/matlab</tt>) directory so that you can call it when needed:		Of course, before you can call <tt>bci2000path</tt>, Matlab needs to know where <tt>bci2000path</tt> itself is. This chicken-and-egg problem is typical of Matlab path-juggling. You could use the graphical <tt>pathtool</tt> to add an absolute reference to the <tt>tools/matlab</tt> directory "permanently" to the Matlab path, but anyone who has made heavy use of Matlab for some time, and is in the habit of using more than one third-party toolbox, will know that this leads to problems sooner or later. One way is to adapt the following lines and put them either in your <tt>startup.m</tt> file, or in some other handy function in the <tt>My Documents\MATLAB</tt> (or <tt>$HOME/matlab</tt>) directory so that you can call it when needed:

			function SetupBCI2000Paths
	olddir = pwd;		olddir = pwd;
	cd('C:\BCI2000') % The absolute path has to be hardcoded somewhere, and here it is. Watch out, in case this is (or becomes) incorrect		cd('C:\BCI2000') % The absolute path has to be hardcoded somewhere, and here it is. Watch out, in case this is (or becomes) incorrect
Line 28:		Line 29:
	bci2000path -AddToSystemPath tools/cmdline % required so that BCI2000CHAIN can call the command-line tools		bci2000path -AddToSystemPath tools/cmdline % required so that BCI2000CHAIN can call the command-line tools
	cd(olddir) % change directory back to where we were before		cd(olddir) % change directory back to where we were before
	~~clear olddir~~

	==bci2000chain==		==bci2000chain==

Jhill at 02:30, 2 March 2012

2012-03-02T02:30:13Z

← Older revision		Revision as of 02:30, 2 March 2012
Line 50:		Line 50:
	==create_bcidat==		==create_bcidat==

	This utility allows you to create "toy" BCI2000 <tt>.dat</tt> files easily, perhaps using only a numeric signal array and a scalar sampling rate. Read the help for this function in order to see how to ~~apply~~ a ~~BCI2000CHAIN to~~ a signal that is stored in a Matlab variable rather than a pre-existing file.		This utility allows you to create "toy" BCI2000 <tt>.dat</tt> files easily, perhaps using only a numeric signal array and a scalar sampling rate. Read the help for this function in order to see how to run a <tt>bci2000chain</tt> on a signal that is stored in a Matlab variable rather than a pre-existing file.

	==read_bciprm==		==read_bciprm==

Jhill at 02:29, 2 March 2012

2012-03-02T02:29:12Z

← Older revision		Revision as of 02:29, 2 March 2012
Line 47:		Line 47:

	See the help documentation in the Matlab file for more details.		See the help documentation in the Matlab file for more details.

			==create_bcidat==

			This utility allows you to create "toy" BCI2000 <tt>.dat</tt> files easily, perhaps using only a numeric signal array and a scalar sampling rate. Read the help for this function in order to see how to apply a BCI2000CHAIN to a signal that is stored in a Matlab variable rather than a pre-existing file.

	==read_bciprm==		==read_bciprm==

Jhill at 04:13, 28 January 2012

2012-01-28T04:13:10Z

← Older revision		Revision as of 04:13, 28 January 2012
Line 1:		Line 1:
	In the <tt>tools/matlab</tt> directory of your BCI2000 distribution, there are several of Matlab functions for offline analysis of recorded data-files, for use on the Matlab command-line or in your own custom scripts. The principal function is <tt>bci2000chain</tt>, which allows you to recreate a BCI2000 processing chain offline, explore the effect of parameter changes, and examine the results in Matlab.		In the <tt>tools/matlab</tt> directory of your BCI2000 distribution, there are several Matlab functions for offline analysis of recorded data-files, for use on the Matlab command-line or in your own custom scripts. The principal function is <tt>bci2000chain</tt>, which allows you to recreate a BCI2000 processing chain offline, explore the effect of parameter changes, and examine the results in Matlab.

	NB: if you prefer clicking the mouse to writing lines of Matlab code, you will probably be happier with the [[User_Reference:BCI2000_Offline_Analysis\|Offline Analysis Matlab GUI]] or the (now non-Matlab-based) [[User_Reference:P300Classifier\|P300Classifier tool]].		NB: if you prefer clicking the mouse to writing lines of Matlab code, you will probably be happier with the [[User_Reference:BCI2000_Offline_Analysis\|Offline Analysis Matlab GUI]] or the (now non-Matlab-based) [[User_Reference:P300Classifier\|P300Classifier tool]].

Jhill: /* bci2000path */

2012-01-28T04:08:26Z

bci2000path

← Older revision		Revision as of 04:08, 28 January 2012
Line 19:		Line 19:
	* remove directories from the path again, or even remove everything BCI2000-related from the Matlab and system paths in one go.		* remove directories from the path again, or even remove everything BCI2000-related from the Matlab and system paths in one go.

	Of course, before you can call <tt>bci2000path</tt>, Matlab needs to know where <tt>bci2000path</tt> itself is. This chicken-and-egg problem is typical of Matlab path-juggling. You could use the graphical <tt>pathtool</tt> to add an absolute reference to the <tt>tools/matlab</tt> directory "permanently" to the Matlab path, but anyone who has made heavy use of Matlab for some time, and is in the habit of using more than one third-party toolbox, will know that this leads to problems sooner or later. One way is to adapt the following lines and put them either in your <tt>startup.m</tt> file, or in some other handy function in the <tt>My Documents\MATLAB</tt> or <tt>$HOME/matlab</tt> so that you can call it when needed:		Of course, before you can call <tt>bci2000path</tt>, Matlab needs to know where <tt>bci2000path</tt> itself is. This chicken-and-egg problem is typical of Matlab path-juggling. You could use the graphical <tt>pathtool</tt> to add an absolute reference to the <tt>tools/matlab</tt> directory "permanently" to the Matlab path, but anyone who has made heavy use of Matlab for some time, and is in the habit of using more than one third-party toolbox, will know that this leads to problems sooner or later. One way is to adapt the following lines and put them either in your <tt>startup.m</tt> file, or in some other handy function in the <tt>My Documents\MATLAB</tt> (or <tt>$HOME/matlab</tt>) directory so that you can call it when needed:

	olddir = pwd;		olddir = pwd;