User Reference:BCI2000Analysis - Revision history

Mellinger: /* Editing the Filter Graph */

2023-09-08T13:33:02Z

Editing the Filter Graph

← Older revision		Revision as of 13:33, 8 September 2023
Line 38:		Line 38:
	Similarly, there is a "CSPSpatialFilter" which is also displayed in red. Normally, it acts like a [[User_Reference:SpatialFilter\|SpatialFilter]], but when selected as an analysis target, it will observe its input data according to the conditions specified in the "Analysis conditions" field. It will then be able to do a [https://en.wikipedia.org/wiki/Common_spatial_pattern "Common Spatial Pattern"] analysis on this data, resulting in a SpatialFilter configuration that provides an optimal signal-to-noise ratio between the two conditions.		Similarly, there is a "CSPSpatialFilter" which is also displayed in red. Normally, it acts like a [[User_Reference:SpatialFilter\|SpatialFilter]], but when selected as an analysis target, it will observe its input data according to the conditions specified in the "Analysis conditions" field. It will then be able to do a [https://en.wikipedia.org/wiki/Common_spatial_pattern "Common Spatial Pattern"] analysis on this data, resulting in a SpatialFilter configuration that provides an optimal signal-to-noise ratio between the two conditions.

	From the “File” menu, filter graphs may be saved to, and loaded from, <tt>.bcigraph</tt> files, which are human readable and may be edited using a text editor. Also, filter graphs may written into C++ <tt>PipeDefinition.cpp</tt> files suitable for use as a signal processing module’s pipe definition file.		From the “File” menu, filter graphs may be saved to, and loaded from, <tt>.bcigraph</tt> files, which are human readable and may be edited using a text editor. Also, filter graphs may written into C++ <tt>PipeDefinition.cpp</tt> files suitable for use as a signal processing module’s [[Programming_Reference:Filter_Chain#Signal_Processing_Filter_Instantiation\|pipe definition file]].

	==Performing Analysis==		==Performing Analysis==

Mellinger: /* Editing the Filter Graph */

2023-09-08T13:18:50Z

Editing the Filter Graph

← Older revision		Revision as of 13:18, 8 September 2023
Line 32:		Line 32:
	A splitter's two branches are each implemented as a [[Programming_Reference:SubchainFilter\|SubchainFilter]].		A splitter's two branches are each implemented as a [[Programming_Reference:SubchainFilter\|SubchainFilter]].

	You insert a filter between two nodes by right-clicking the connection between them, and choosing “Filter…” from the popup menu. A dialog window appears that contains a menu with all pre-existing types of filters, so you may select e.g. “SpatialFilter”, “P3TemporalFilter”, and so on. As a special entry, the list contains “Filter from DLL…” which allows you to choose a [[Programming Reference:Filter DLLs\|BCI2000 filter DLL]]. This is especially useful when developing a filter that is not part of the [[User_Reference:Filters\|standard set of BCI2000 filters]]~~. Information about how to compile your own filter as a filter DLL is provided~~ [[Programming_Reference:Filter_DLLs#Howto:_Building_your_own_filter_as_a_BCI2000_Filter_DLL\|here]].		You insert a filter between two nodes by right-clicking the connection between them, and choosing “Filter…” from the popup menu. A dialog window appears that contains a menu with all pre-existing types of filters, so you may select e.g. “SpatialFilter”, “P3TemporalFilter”, and so on. As a special entry, the list contains “Filter from DLL…” which allows you to choose a [[Programming Reference:Filter DLLs\|BCI2000 filter DLL]]. This is especially useful when developing a filter that is not part of the [[User_Reference:Filters\|standard set of BCI2000 filters]] (see [[Programming_Reference:Filter_DLLs#Howto:_Building_your_own_filter_as_a_BCI2000_Filter_DLL\|here]] for a description how to build your own filter as a BCI2000 filter DLL).

	A special role plays the [[User_Reference:LinearClassifier\|LinearClassifier]] filter, which is displayed in red. At its location, data is collected according to the conditions specified in the “Analysis conditions” field. When performing classifier training (see below), this data is then used to train the classifier, and training results are applied to test the classifier.		A special role plays the [[User_Reference:LinearClassifier\|LinearClassifier]] filter, which is displayed in red. At its location, data is collected according to the conditions specified in the “Analysis conditions” field. When performing classifier training (see below), this data is then used to train the classifier, and training results are applied to test the classifier.

Mellinger: /* Editing the Filter Graph */

2023-09-08T13:17:30Z

Editing the Filter Graph

← Older revision		Revision as of 13:17, 8 September 2023
Line 32:		Line 32:
	A splitter's two branches are each implemented as a [[Programming_Reference:SubchainFilter\|SubchainFilter]].		A splitter's two branches are each implemented as a [[Programming_Reference:SubchainFilter\|SubchainFilter]].

	You insert a filter between two nodes by right-clicking the connection between them, and choosing “Filter…” from the popup menu. A dialog window appears that contains a menu with all pre-existing types of filters, so you may select e.g. “SpatialFilter”, “P3TemporalFilter”, and so on. As a special entry, the list contains “Filter from DLL…” which allows you to choose a [[Programming Reference:Filter DLLs\|BCI2000 filter DLL]]. This is especially useful when developing a filter that is not part of the [[User_Reference:Filters\|standard set of BCI2000 filters]].		You insert a filter between two nodes by right-clicking the connection between them, and choosing “Filter…” from the popup menu. A dialog window appears that contains a menu with all pre-existing types of filters, so you may select e.g. “SpatialFilter”, “P3TemporalFilter”, and so on. As a special entry, the list contains “Filter from DLL…” which allows you to choose a [[Programming Reference:Filter DLLs\|BCI2000 filter DLL]]. This is especially useful when developing a filter that is not part of the [[User_Reference:Filters\|standard set of BCI2000 filters]]. Information about how to compile your own filter as a filter DLL is provided [[Programming_Reference:Filter_DLLs#Howto:_Building_your_own_filter_as_a_BCI2000_Filter_DLL\|here]].

	A special role plays the [[User_Reference:LinearClassifier\|LinearClassifier]] filter, which is displayed in red. At its location, data is collected according to the conditions specified in the “Analysis conditions” field. When performing classifier training (see below), this data is then used to train the classifier, and training results are applied to test the classifier.		A special role plays the [[User_Reference:LinearClassifier\|LinearClassifier]] filter, which is displayed in red. At its location, data is collected according to the conditions specified in the “Analysis conditions” field. When performing classifier training (see below), this data is then used to train the classifier, and training results are applied to test the classifier.

Mellinger: /* Using the SuggestDebugging function */

2023-09-08T13:14:01Z

Using the SuggestDebugging function

← Older revision		Revision as of 13:14, 8 September 2023
Line 114:		Line 114:
	===Setting breakpoints in the IDE===		===Setting breakpoints in the IDE===
	Start up ''BCI2000Analysis'', and attach a debugger to the process. In the debugger IDE, navigate to your filter's cpp file, and set breakpoints as you see fit. Then, activate the DLL by adding a filter DLL node and choosing your filter, and run the filter chain by clicking "Run analysis". Execution should stop when any of the breakpoints is hit.		Start up ''BCI2000Analysis'', and attach a debugger to the process. In the debugger IDE, navigate to your filter's cpp file, and set breakpoints as you see fit. Then, activate the DLL by adding a filter DLL node and choosing your filter, and run the filter chain by clicking "Run analysis". Execution should stop when any of the breakpoints is hit.
	===Using ~~the~~ <tt>SuggestDebugging</tt> ~~function~~===		===Using a <tt>SuggestDebugging</tt> Statement===
	In your filter's cpp file, include <tt>Debugging.h</tt>, and add a line <pre>SuggestDebugging << "Foo";</pre> anywhere in your filter's functions. When the filter DLL is activated and the <tt>SuggestDebugging</tt> statement is executed, it will display a message box. You may then attach a debugger to the ''BCI2000Analysis'' process, and click "yes" in the message box to drop into the debugger.		In your filter's cpp file, include <tt>Debugging.h</tt>, and add a line <pre>SuggestDebugging << "Foo";</pre> anywhere in your filter's functions. When the filter DLL is activated and the <tt>SuggestDebugging</tt> statement is executed, it will display a message box. You may then attach a debugger to the ''BCI2000Analysis'' process, and click "yes" in the message box to drop into the debugger.

Mellinger: /* See also */

2023-09-08T13:12:46Z

Mellinger: /* The BCI2000Analysis main window */

2023-09-08T13:06:03Z

The BCI2000Analysis main window

← Older revision		Revision as of 13:06, 8 September 2023
Line 9:		Line 9:
	==The BCI2000Analysis main window==		==The BCI2000Analysis main window==
	The main window consists of		The main window consists of
	*areas for training and ~~testing~~ data,		*areas for training and test data,
	*a pane containing the filter graph,		*a pane containing the filter graph,
	*a log area that holds log information produced by filters (if any).		*a log area that holds log information produced by filters (if any).

Mellinger: /* See also */

2023-09-08T13:04:27Z

Mellinger: /* Introduction */

2023-09-07T15:58:10Z

Introduction

← Older revision		Revision as of 15:58, 7 September 2023
Line 1:		Line 1:
	==Introduction==		==Introduction==
	The BCI2000Analysis program is a ~~universal~~ tool for		The BCI2000Analysis program is a versatile tool for
	* Applying Signal Processing filters to existing data,		* Applying Signal Processing filters to existing data,
	* Testing and Benchmarking new Signal Processing filters,		* Testing and Benchmarking new Signal Processing filters,

Mellinger: /* Editing the Filter Graph */

2023-09-05T14:27:12Z

Editing the Filter Graph

← Older revision		Revision as of 14:27, 5 September 2023
Line 29:		Line 29:
	As it suits the BCI2000 model, a filter graph will always begin with a single Source node, and end in a single Application node. In between, filtering may be split into multiple branches but must finally be joined into a single node. By the way filter graph editing works, it is not possible to produce invalid graphs. Whenever you insert a splitter node, a corresponding joint is automatically inserted for you. You may add and remove filters into and from the new branches but when you remove a splitter, all its branches and its joint node are removed.		As it suits the BCI2000 model, a filter graph will always begin with a single Source node, and end in a single Application node. In between, filtering may be split into multiple branches but must finally be joined into a single node. By the way filter graph editing works, it is not possible to produce invalid graphs. Whenever you insert a splitter node, a corresponding joint is automatically inserted for you. You may add and remove filters into and from the new branches but when you remove a splitter, all its branches and its joint node are removed.

	Internally, a splitter and its corresponding joint node are implemented by a [[Programming_Reference:ParallelCombination\|ParallelCombination]].		Internally, a splitter and its corresponding joint node are implemented by a [[Programming_Reference:ParallelCombination\|ParallelCombination]] object.
	A splitter's two branches are each implemented as a [[Programming_Reference:SubchainFilter\|SubchainFilter]].		A splitter's two branches are each implemented as a [[Programming_Reference:SubchainFilter\|SubchainFilter]].

Mellinger: /* Editing the Filter Graph */

2023-09-05T14:25:55Z

Editing the Filter Graph

← Older revision		Revision as of 14:25, 5 September 2023
Line 28:		Line 28:

	As it suits the BCI2000 model, a filter graph will always begin with a single Source node, and end in a single Application node. In between, filtering may be split into multiple branches but must finally be joined into a single node. By the way filter graph editing works, it is not possible to produce invalid graphs. Whenever you insert a splitter node, a corresponding joint is automatically inserted for you. You may add and remove filters into and from the new branches but when you remove a splitter, all its branches and its joint node are removed.		As it suits the BCI2000 model, a filter graph will always begin with a single Source node, and end in a single Application node. In between, filtering may be split into multiple branches but must finally be joined into a single node. By the way filter graph editing works, it is not possible to produce invalid graphs. Whenever you insert a splitter node, a corresponding joint is automatically inserted for you. You may add and remove filters into and from the new branches but when you remove a splitter, all its branches and its joint node are removed.

			Internally, a splitter and its corresponding joint node are implemented by a [[Programming_Reference:ParallelCombination\|ParallelCombination]].
			A splitter's two branches are each implemented as a [[Programming_Reference:SubchainFilter\|SubchainFilter]].

	You insert a filter between two nodes by right-clicking the connection between them, and choosing “Filter…” from the popup menu. A dialog window appears that contains a menu with all pre-existing types of filters, so you may select e.g. “SpatialFilter”, “P3TemporalFilter”, and so on. As a special entry, the list contains “Filter from DLL…” which allows you to choose a [[Programming Reference:Filter DLLs\|BCI2000 filter DLL]]. This is especially useful when developing a filter that is not part of the [[User_Reference:Filters\|standard set of BCI2000 filters]].		You insert a filter between two nodes by right-clicking the connection between them, and choosing “Filter…” from the popup menu. A dialog window appears that contains a menu with all pre-existing types of filters, so you may select e.g. “SpatialFilter”, “P3TemporalFilter”, and so on. As a special entry, the list contains “Filter from DLL…” which allows you to choose a [[Programming Reference:Filter DLLs\|BCI2000 filter DLL]]. This is especially useful when developing a filter that is not part of the [[User_Reference:Filters\|standard set of BCI2000 filters]].

← Older revision		Revision as of 13:18, 8 September 2023
Line 32:		Line 32:
	A splitter's two branches are each implemented as a [[Programming_Reference:SubchainFilter\|SubchainFilter]].		A splitter's two branches are each implemented as a [[Programming_Reference:SubchainFilter\|SubchainFilter]].

	You insert a filter between two nodes by right-clicking the connection between them, and choosing “Filter…” from the popup menu. A dialog window appears that contains a menu with all pre-existing types of filters, so you may select e.g. “SpatialFilter”, “P3TemporalFilter”, and so on. As a special entry, the list contains “Filter from DLL…” which allows you to choose a [[Programming Reference:Filter DLLs\|BCI2000 filter DLL]]. This is especially useful when developing a filter that is not part of the [[User_Reference:Filters\|standard set of BCI2000 filters]]~~. Information about how to compile your own filter as a filter DLL is provided~~ [[Programming_Reference:Filter_DLLs#Howto:_Building_your_own_filter_as_a_BCI2000_Filter_DLL\|here]].		You insert a filter between two nodes by right-clicking the connection between them, and choosing “Filter…” from the popup menu. A dialog window appears that contains a menu with all pre-existing types of filters, so you may select e.g. “SpatialFilter”, “P3TemporalFilter”, and so on. As a special entry, the list contains “Filter from DLL…” which allows you to choose a [[Programming Reference:Filter DLLs\|BCI2000 filter DLL]]. This is especially useful when developing a filter that is not part of the [[User_Reference:Filters\|standard set of BCI2000 filters]] (see [[Programming_Reference:Filter_DLLs#Howto:_Building_your_own_filter_as_a_BCI2000_Filter_DLL\|here]] for a description how to build your own filter as a BCI2000 filter DLL).

	A special role plays the [[User_Reference:LinearClassifier\|LinearClassifier]] filter, which is displayed in red. At its location, data is collected according to the conditions specified in the “Analysis conditions” field. When performing classifier training (see below), this data is then used to train the classifier, and training results are applied to test the classifier.		A special role plays the [[User_Reference:LinearClassifier\|LinearClassifier]] filter, which is displayed in red. At its location, data is collected according to the conditions specified in the “Analysis conditions” field. When performing classifier training (see below), this data is then used to train the classifier, and training results are applied to test the classifier.

← Older revision		Revision as of 13:17, 8 September 2023
Line 32:		Line 32:
	A splitter's two branches are each implemented as a [[Programming_Reference:SubchainFilter\|SubchainFilter]].		A splitter's two branches are each implemented as a [[Programming_Reference:SubchainFilter\|SubchainFilter]].

	You insert a filter between two nodes by right-clicking the connection between them, and choosing “Filter…” from the popup menu. A dialog window appears that contains a menu with all pre-existing types of filters, so you may select e.g. “SpatialFilter”, “P3TemporalFilter”, and so on. As a special entry, the list contains “Filter from DLL…” which allows you to choose a [[Programming Reference:Filter DLLs\|BCI2000 filter DLL]]. This is especially useful when developing a filter that is not part of the [[User_Reference:Filters\|standard set of BCI2000 filters]].		You insert a filter between two nodes by right-clicking the connection between them, and choosing “Filter…” from the popup menu. A dialog window appears that contains a menu with all pre-existing types of filters, so you may select e.g. “SpatialFilter”, “P3TemporalFilter”, and so on. As a special entry, the list contains “Filter from DLL…” which allows you to choose a [[Programming Reference:Filter DLLs\|BCI2000 filter DLL]]. This is especially useful when developing a filter that is not part of the [[User_Reference:Filters\|standard set of BCI2000 filters]]. Information about how to compile your own filter as a filter DLL is provided [[Programming_Reference:Filter_DLLs#Howto:_Building_your_own_filter_as_a_BCI2000_Filter_DLL\|here]].

	A special role plays the [[User_Reference:LinearClassifier\|LinearClassifier]] filter, which is displayed in red. At its location, data is collected according to the conditions specified in the “Analysis conditions” field. When performing classifier training (see below), this data is then used to train the classifier, and training results are applied to test the classifier.		A special role plays the [[User_Reference:LinearClassifier\|LinearClassifier]] filter, which is displayed in red. At its location, data is collected according to the conditions specified in the “Analysis conditions” field. When performing classifier training (see below), this data is then used to train the classifier, and training results are applied to test the classifier.

← Older revision		Revision as of 13:12, 8 September 2023
Line 109:		Line 109:

	[[File:BCI2000Analysis ApplicationData4.png]]		[[File:BCI2000Analysis ApplicationData4.png]]

			==Debugging a filter DLL==
			To debug a filter contained in a DLL, you have two options:
			===Setting breakpoints in the IDE===
			Start up ''BCI2000Analysis'', and attach a debugger to the process. In the debugger IDE, navigate to your filter's cpp file, and set breakpoints as you see fit. Then, activate the DLL by adding a filter DLL node and choosing your filter, and run the filter chain by clicking "Run analysis". Execution should stop when any of the breakpoints is hit.
			===Using the <tt>SuggestDebugging</tt> function===
			In your filter's cpp file, include <tt>Debugging.h</tt>, and add a line <pre>SuggestDebugging << "Foo";</pre> anywhere in your filter's functions. When the filter DLL is activated and the <tt>SuggestDebugging</tt> statement is executed, it will display a message box. You may then attach a debugger to the ''BCI2000Analysis'' process, and click "yes" in the message box to drop into the debugger.

			'''NOTE:''' For these debugging instructions to work, it is necessary that both ''BCI2000Analysis'' and the filter DLL have been compiled in Debug mode.

	==See also==		==See also==

← Older revision		Revision as of 13:04, 8 September 2023
Line 111:		Line 111:

	==See also==		==See also==
	[[User Reference:BCI2000Viewer]], [[User Reference:BCI2000FileInfo]], [[User Reference:BCI2000 Offline Analysis]], [[User Reference:P300Classifier]]		[[User Reference:BCI2000Viewer]], [[User Reference:BCI2000FileInfo]], [[User Reference:BCI2000 Offline Analysis]], [[User Reference:P300Classifier]], [[Programming Reference:Filter DLLs]]

	[[Category:User Interface]][[Category:Data Analysis Tools]]		[[Category:User Interface]][[Category:Data Analysis Tools]]