User Reference:Command Line Processing - Revision history

Mellinger: /* Building BCI2000 command line tools */

2025-11-07T07:24:42Z

Building BCI2000 command line tools

← Older revision		Revision as of 07:24, 7 November 2025
Line 46:		Line 46:
	==Building BCI2000 command line tools==		==Building BCI2000 command line tools==

	Command line tools are built by the BCI2000 build system if ~~BUILD_COMMANDLINE_TOOLS~~ is enabled in CMake.		Command line tools are built by the BCI2000 build system if BUILD_COMMANDLINE_FILTERS is enabled in CMake.

	In order to use the command line tools, you will need to add the full path		In order to use the command line tools, you will need to add the full path

Mellinger: /* Building BCI2000 command line tools */

2025-11-07T07:22:54Z

Building BCI2000 command line tools

← Older revision		Revision as of 07:22, 7 November 2025
Line 46:		Line 46:
	==Building BCI2000 command line tools==		==Building BCI2000 command line tools==

	Command line tools are built ~~automatically~~ by the BCI2000 build system if ~~building of BCI2000 tools~~ is enabled.		Command line tools are built by the BCI2000 build system if BUILD_COMMANDLINE_TOOLS is enabled in CMake.

	In order to use the command line tools, you will need to add the full path		In order to use the command line tools, you will need to add the full path

Mellinger: /* Offline-only filters */

2022-12-23T16:35:27Z

Offline-only filters

← Older revision		Revision as of 16:35, 23 December 2022
Line 153:		Line 153:

	BCI2000_ADD_CMDLINE_FILTER( LinearClassifier FROM ${SIGPROC_DIR} ) # a simpler example		BCI2000_ADD_CMDLINE_FILTER( LinearClassifier FROM ${SIGPROC_DIR} ) # a simpler example

			===Filters with sub filter chains===
			If a filter itself contains other filters, e.g. in two parallel subchains, you will include those filters as <tt>EXTRA_SOURCES</tt> as indicated above. However, this will include all the <tt>RegisterFilter</tt> in these <tt>.cpp</tt> files as well, so the additional filters will be instantiated on the filter tool's top level as well as within its subchains. Typically, this is not desired.

			To avoid this behavior, put a file <tt>PipeDefinition.cpp</tt> into your <tt>MyFilter/cmdline</tt> subdirectory, with the following content (assuming the filter is named "MyFilter"):

			#include "MyFilter.h"
			Filter(MyFilter, 2.A)

			Then, add <tt>PipeDefinition.cpp</tt> among the <tt>EXTRA_SOURCES</tt>, rerun CMake, and recompile.


	===Offline-only filters===		===Offline-only filters===

Mellinger: /* Compiling an existing filter as a command line tool */

2022-12-15T13:42:37Z

Compiling an existing filter as a command line tool

← Older revision		Revision as of 13:42, 15 December 2022
Line 142:		Line 142:
	SET( SIGPROC_DIR ${BCI2000_ROOT_DIR}/src/shared/modules/signalprocessing )		SET( SIGPROC_DIR ${BCI2000_ROOT_DIR}/src/shared/modules/signalprocessing )

	BCI2000_ADD_CMDLINE_FILTER( ARFilter FROM ${SIGPROC_DIR} # because ARFilter.cpp and ARFilter.h reside there		BCI2000_ADD_CMDLINE_FILTER( ARFilter FROM ${SIGPROC_DIR} # because ARFilter.cpp and ARFilter.h
	INCLUDING "MATH" # because the "MATH" external library is required		# reside there
	EXTRA_SOURCES ${SIGPROC_DIR}/ARThread.cpp # because the filter relies on one or more additional source files		INCLUDING "MATH" # because the "MATH" external library
	EXTRA_HEADERS ${SIGPROC_DIR}/ARThread.h ) # ...and their corresponding headers		# is required
			EXTRA_SOURCES ${SIGPROC_DIR}/ARThread.cpp # because the filter relies on one or more
			# additional source files
			${SIGPROC_DIR}/WindowingFilter.cpp # only one EXTRA_SOURCES is allowed
			EXTRA_HEADERS ${SIGPROC_DIR}/ARThread.h ) # ...and their corresponding headers
			${SIGPROC_DIR}/WindowingFilter.h # only one EXTRA_HEADERS is allowed

	BCI2000_ADD_CMDLINE_FILTER( LinearClassifier FROM ${SIGPROC_DIR} ) # a simpler example		BCI2000_ADD_CMDLINE_FILTER( LinearClassifier FROM ${SIGPROC_DIR} ) # a simpler example

	===Offline-only filters===		===Offline-only filters===

Mellinger: /* Further information */

2012-06-13T11:31:55Z

Further information

← Older revision		Revision as of 11:31, 13 June 2012
Line 201:		Line 201:

	*The ''cygwin'' Win32 port of GNU tools can be downloaded at <tt>http://www.cygwin.com/</tt>.		*The ''cygwin'' Win32 port of GNU tools can be downloaded at <tt>http://www.cygwin.com/</tt>.

	*The free command line version of the Borland C++ compiler is available at <tt>http://www.borland.com/downloads/download_cbuilder.html</tt>.

	[[Category:External Interfaces]][[Category:Data Analysis Tools]][[Category:Development]]		[[Category:External Interfaces]][[Category:Data Analysis Tools]][[Category:Development]]

Jhill: /* Compiling an existing filter as a command line tool */

2012-03-12T21:12:39Z

Compiling an existing filter as a command line tool

← Older revision		Revision as of 21:12, 12 March 2012
Line 131:		Line 131:
	You should get a message stating that the program applies the "MyFilter" filter to its input.		You should get a message stating that the program applies the "MyFilter" filter to its input.

	One potential complication is that the <tt>BCI2000_ADD_CMDLINE_FILTER</tt> macro cannot come in the same <tt>CMakeLists.txt</tt> file as the declaration of a BCI2000 module. Let us suppose you have followed the [[Programming_Howto:Quickstart_Guide\|programmers' quickstart guide]] to create a custom signal-processing module in <tt>src/custom/MyModule</tt> and add a custom filter <tt>MyFilter</tt> to it. A safe procedure is:		One potential complication is that the <tt>BCI2000_ADD_CMDLINE_FILTER</tt> macro cannot come in the same <tt>CMakeLists.txt</tt> file as the declaration of a BCI2000 module. Let us suppose you have followed the [[Programming_Howto:Quickstart_Guide\|programmers' quickstart guide]] to create a custom signal-processing module in <tt>src/custom/MyModule</tt> and add a custom filter <tt>MyFilter</tt> to it. A safe procedure (which can be automated used the [[Programming_Howto:Quickstart_Guide#Configuring_your_new_filter_for_offline_use\|NewBCI2000FilterTool]] utility) is as follows:

	# Create a subdirectory <tt>src/custom/MyModule/cmdline</tt>		# Create a subdirectory <tt>src/custom/MyModule/cmdline</tt>

Mellinger: /* Examples */

2012-01-30T14:26:14Z

Examples

← Older revision		Revision as of 14:26, 30 January 2012
Line 160:		Line 160:

	The following examples work from the Windows NT command prompt. Nevertheless, we would like to point the reader to the free ''cygwin'' collection of GNU tools ported to the Win32 API. ''Cygwin'' provides the power of the <tt>bash</tt> shell, and of programs like the <tt>sed</tt> stream editor.		The following examples work from the Windows NT command prompt. Nevertheless, we would like to point the reader to the free ''cygwin'' collection of GNU tools ported to the Win32 API. ''Cygwin'' provides the power of the <tt>bash</tt> shell, and of programs like the <tt>sed</tt> stream editor.
	Although the BCI2000 command line tools cannot be compiled ~~with <tt>gcc</tt>~~, they work fine when called from ''cygwin'' .		Although the BCI2000 command line tools cannot be '''compiled''' from within ''cygwin'', they work fine when '''called''' from ''cygwin'' .

	===Extracting parameters===		===Extracting parameters===

Mellinger: /* Introduction */

2012-01-30T14:22:01Z

Introduction

← Older revision		Revision as of 14:22, 30 January 2012
Line 24:		Line 24:

	This document explains the command line tools available for working with BCI2000 files, and how to build BCI2000 filters as single executables that may be combined to form a chain of filters.		This document explains the command line tools available for working with BCI2000 files, and how to build BCI2000 filters as single executables that may be combined to form a chain of filters.


	==Command line interfaces==		==Command line interfaces==

Jhill: /* Processing data with BCI2000 filters and importing the results into Matlab */

2012-01-28T03:59:56Z

Processing data with BCI2000 filters and importing the results into Matlab

← Older revision		Revision as of 03:59, 28 January 2012
Line 175:		Line 175:
	===Processing data with BCI2000 filters and importing the results into Matlab===		===Processing data with BCI2000 filters and importing the results into Matlab===

	To process data with the filters used in the mu-training on-line system, saving the AR spectrum as Matlab file, execute		First, consider using the higher-level Matlab interface [[User_Reference:Matlab_Tools\|bci2000chain]] instead. But if you decide you want to do it by hand, and you want to process data with the filters used in the mu-training on-line system, saving the AR spectrum as Matlab file, execute
	bci_dat2stream < mydata.dat \| TransmissionFilter \| SpatialFilter \| ARFilter \| bci_stream2mat > myspectra.mat		bci_dat2stream < mydata.dat \| TransmissionFilter \| SpatialFilter \| ARFilter \| bci_stream2mat > myspectra.mat

Jhill: /* Off-line only filters */

2012-01-28T03:52:15Z

Off-line only filters

← Older revision		Revision as of 03:52, 28 January 2012
Line 150:		Line 150:
	BCI2000_ADD_CMDLINE_FILTER( LinearClassifier FROM ${SIGPROC_DIR} ) # a simpler example		BCI2000_ADD_CMDLINE_FILTER( LinearClassifier FROM ${SIGPROC_DIR} ) # a simpler example

	===~~Off~~-~~line~~ only filters===		===Offline-only filters===

	For off-line analysis, data must often be partitioned into "segments" before performing statistics. As there is no notion of "segments" in the on-line data and file format, we suggest using the "Running" state to indicate segments in the following way:		For off-line analysis, data must often be partitioned into "segments" before performing statistics. As there is no notion of "segments" in the on-line data and file format, we suggest using the "Running" state to indicate segments in the following way: