Difference: DocsSectionsBlockFile (1 vs. 31)

Revision 3113 Nov 2014 - Main.PhilipVanDenBroek

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
<---Start1--->

Topics and keys for block files

Line: 46 to 46
 
sets the amount of information that is displayed during processing.
VerbosityLevel = 'ERROR' % (default) only displays errors and approximately every 10 seconds it indicates progress made.
VerbosityLevel = 'INFO' % also displays which markers' actions are currently being processed in Matlab command window.
VerbosityLevel = 'WARNING' % also displays warning messages.
VerbosityLevel = 'DEBUG' % also displays extra information about processed actions (use only in case debugging is required).

RealTime:

Changed:
<
<
use only in case running with an offline data source, i.e., from file or simulated data. Set this value to true in order to simulate real-time data processing. Set it to false if offline data processing should be done as quickly as possible.
RealTime = true % (or 1)
>
>
This key is deprecated.
  Parallel:
set to true to enable parallel processing of markers' actions. In the experiment definition table it needs to be specified which markers actions are allowed to be processed in parallel. See .... for more details.
Parallel = true % (or 1, default = false)
Line: 77 to 77
 
the file containing the experiment definition tables (.xls or .edt). This key is obligatory.
ExperimentDefinitionFile = '/Volumes/bci_stims/my_experiment/myblock.xls'

ExperimentDefinitionData:

Changed:
<
<
defines in which table or sheet BrainStream can find information about which markers request data for their actions.
ExperimentDefinitionData = 'DataSelection' % (=default)

>
>
This key is deprecated.

  ExperimentDefinitionSubFile:
Changed:
<
<
defines from which table or sheet BrainStream should start reading markers' actions.
ExperimentDefinitionSubFile = 'Actions' % (=default)

DataFile (deprecated!, don't use these keys, use RunMode.DataSource instead)
DataFileDir (deprecated!, don't use these keys, use RunMode.DataSource instead)
>
>
This key is deprecated.
  StimulusFile:
Changed:
<
<
defines Logic stimulus presentation file
StimulusFile = '/Volumes/bci_stims/my_experiment/logic/myblock.lso'

>
>
This key is deprecated.

  ActiviewConfigFile:
Changed:
<
<
defines settings for Actiview to control BioSemi's Active2 acquisition, i.e., number of acquired channels, sample rate etc.
ActiviewConfigFile = 'Actiview_MMMdefault.cfg' % (default)
ActiviewConfigFile = 'Actiview_MMMdefault_cap64.cfg'
ActiviewConfigFile = 'Actiview_MMMaib_cap64.cfg'
ActiviewConfigFile = 'Actiview_MMMaib.cfg'

[BiosemiAcq]

Host:

ip number of host running Actiview
Host = '123.456.789.100' % (or 'localhost', or 'server.dcc.ru.nl')

Port:

port to connect to on host running Actiview
Port = 5050
>
>
This key is deprecated.
 
Line: 123 to 112
 
translates client name (descriptive for the actions that execute parallel-wise) into DNS name or ip-number.
client1 = '131.174.123.456'
client2 = 'eegstim.mydomain.nl'
client3 = 'core1' % dedicate/reserve specific core
client4 = 'cores' % BrainStream picks first available core
client5 = 'local' % execute serial-wise (overruled; no parallel execution)

Deleted:
<
<

[StimulusPresentation]

StimulusPresentationSource:

defines stimulus presentation source
StimulusPresentationSource = 'Logic' % (default)
StimuluspresentationSource = 'PsychToolBox'
StimuluspresentationSource = 'PsychToolBox2' % uses BrainStreams parallel processing option

StimulusPresentationRemotePath:

defines stimulus presentation folders to add to Matlab path at remote client side.
Note: $REPOSROOT will be replaced by remote clients specific repository root.
StimulusPresentationRemotePath = '$REPOSROOT/external_toolboxes/PsychToolbox'
 

[<client>] (name of the client specified under topic [Clients])

Changed:
<
<
Plugins:
cell array of plugin folders to add to the client's Matlab search path
>
>
MatlabPathAdd:
specify list of extra folders to add to the clients Matlab path
MatlabPathAdd = {'/Volumes/code/my_experiments/'}
 

Revision 3023 Mar 2012 - Main.MarjoleinVanDerWaal

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
<---Start1--->

Topics and keys for block files

Generate current PDF

Changed:
<
<
In your block files, two topics are always required: DataSources with key <datasource>, and Files with keys ExperimentDefinitionFile and OutFolder. You can add as many topics with corresponding keys as you like as long as you don't use any of the topics used by BrainStream. This is an overview of topics and keys and their meaning. Keys starting with an asterisk are obligatory.
>
>
In your block files, two topics are always required: DataSources with key <datasource>, and Files with keys ExperimentDefinitionFile and OutFolder. You can add as many topics with corresponding keys as you like as long as you don't use any of the topics used by BrainStream. This is an overview of topics and keys and their meaning. Keys indicated with an asterisk are obligatory.
 

Revision 2916 Dec 2011 - Main.MarjoleinVanDerWaal

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
<---Start1--->

Topics and keys for block files

Generate current PDF

Changed:
<
<
In your block files, two topics are always required: RunMode with key DataSource, and Files with keys, ExperimentDefinitionFile and OutFolder. You can add as many topics with corresponding keys as you like as long as you don't use any of the topics used by BrainStream. This is an overview of topics and keys and their meaning. Keys starting with an asterisk are obligatory.
>
>
In your block files, two topics are always required: DataSources with key <datasource>, and Files with keys ExperimentDefinitionFile and OutFolder. You can add as many topics with corresponding keys as you like as long as you don't use any of the topics used by BrainStream. This is an overview of topics and keys and their meaning. Keys starting with an asterisk are obligatory.
 
Line: 36 to 36
 
Changed:
<
<
screenoutputlevel: deprecated, use VerbosityLevel instead
>
>
screenoutputlevel:
This key is deprecated, use VerbosityLevel instead.

  VerbosityLevel:
Changed:
<
<
sets the amount of information that is displayed during processing.
VerbosityLevel = 'ERROR' % (default) only displays errors and approximately every 10 seconds it indicates progress made.
VerbosityLevel = 'INFO' % also displays which markers' actions are currently being processed in Matlab command window.
VerbosityLevel = 'WARNING' % also displays warning messages.
VerbosityLevel = 'DEBUG' % also displays extra information about processed actions (use only in case debugging is required).
>
>
sets the amount of information that is displayed during processing.
VerbosityLevel = 'ERROR' % (default) only displays errors and approximately every 10 seconds it indicates progress made.
VerbosityLevel = 'INFO' % also displays which markers' actions are currently being processed in Matlab command window.
VerbosityLevel = 'WARNING' % also displays warning messages.
VerbosityLevel = 'DEBUG' % also displays extra information about processed actions (use only in case debugging is required).

  RealTime:
use only in case running with an offline data source, i.e., from file or simulated data. Set this value to true in order to simulate real-time data processing. Set it to false if offline data processing should be done as quickly as possible.
RealTime = true % (or 1)

Revision 2816 Dec 2011 - Main.MarjoleinVanDerWaal

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
<---Start1--->

Topics and keys for block files

Line: 13 to 13
 

*<datasource>:

Changed:
<
<
defines the name and type of each data source. A data source can be a hardware device, a recorded data file or simulated data (see Connecting Data Sources). This key is obligatory.
<datasource> = '<buffer address>:<port>:<device>'
<datasource> = '<data file>:<device>'
<datasource> = 'simulate:<device>'

>
>
defines the name and type of each data source. A data source can be a hardware device, a recorded data file or simulated data (see Connecting Data Sources). This key is obligatory.
<datasource> = '<buffer address>:<port>:<device>' %acquisition device
<datasource> = '<data file>:<device>' %recorded data file
<datasource> = 'simulate:<device>' %simulated data

 
Line: 36 to 36
 
Changed:
<
<
screenoutputlevel:
sets the amount of information that is displayed during processing.
screenoutputlevel = 'ERROR' % (default) only displays errors and approximately every 10 seconds it indicates progress made.
screenoutputlevel = 'INFO' % also displays which markers' actions are currently being processed in Matlab command window.
screenoutputlevel = 'WARNING' % also displays warning messages.
screenoutputlevel = 'DEBUG' % also displays extra information about processed actions (use only in case debugging is required).
>
>
screenoutputlevel: deprecated, use VerbosityLevel instead

VerbosityLevel:

sets the amount of information that is displayed during processing.
VerbosityLevel = 'ERROR' % (default) only displays errors and approximately every 10 seconds it indicates progress made.
VerbosityLevel = 'INFO' % also displays which markers' actions are currently being processed in Matlab command window.
VerbosityLevel = 'WARNING' % also displays warning messages.
VerbosityLevel = 'DEBUG' % also displays extra information about processed actions (use only in case debugging is required).
  RealTime:
use only in case running with an offline data source, i.e., from file or simulated data. Set this value to true in order to simulate real-time data processing. Set it to false if offline data processing should be done as quickly as possible.
RealTime = true % (or 1)
Line: 152 to 154
 

Cap:

Changed:
<
<
defines which cap will be used for systems that can use only one cap type, e.g. Emotiv. For systems that can use multiple caps, e.g. BioSemi, specify under topic [<datasource>]. User functions are responsible for changing hdr and current cap information after changing the cap (for example after spatial downsampling).
Cap = 'cap_emotiv_epoch.txt'
Cap = 'cap_neurosky_thinkgear.txt'

>
>
defines which cap will be used for systems that can use only one cap type, e.g. Emotiv. For systems that can use multiple caps, e.g. BioSemi, specify under topic [<datasource>]. User functions are responsible for changing hdr and current cap information after changing the cap (for example after spatial downsampling).
Cap = 'cap_emotiv_epoch.txt'
Cap = 'cap_neurosky_thinkgear.txt'

SendMarkerFnc:
defines which sndMarker function will be used for inserting markers via the hardware. Default is 'sndBufferMarker', which inserts all markers via the FieldTrip buffer (i.e. not via the hardware). For more information about inserting markers via the hardware or the FieldTrip buffer, click here.
SendMarkerFnc = 'sndBufferMarker' %default

 
<---End1--->

Revision 2721 Nov 2011 - Main.MarjoleinVanDerWaal

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
<---Start1--->

Topics and keys for block files

Line: 119 to 119
 
Changed:
<
<
[BrainStream.StimulusPresentation]
>
>
[StimulusPresentation]
 

StimulusPresentationSource:

Revision 2617 Nov 2011 - Main.MarjoleinVanDerWaal

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
<---Start1--->

Topics and keys for block files

Line: 7 to 7
  In your block files, two topics are always required: RunMode with key DataSource, and Files with keys, ExperimentDefinitionFile and OutFolder. You can add as many topics with corresponding keys as you like as long as you don't use any of the topics used by BrainStream. This is an overview of topics and keys and their meaning. Keys starting with an asterisk are obligatory.
Added:
>
>

[DataSources]

*<datasource>:

defines the name and type of each data source. A data source can be a hardware device, a recorded data file or simulated data (see Connecting Data Sources). This key is obligatory.
<datasource> = '<buffer address>:<port>:<device>'
<datasource> = '<data file>:<device>'
<datasource> = 'simulate:<device>'

 

[RunMode]

Changed:
<
<
*DataSource:
defines what source is responsible for supplying the raw data to BrainStream. This key is obligatory.
DataSource = 'BioSemiAcq' % BioSemi's Active2.
DataSource = '/my_data/filename.ext' % specify any file supported by fieldtrip/FileIO (also fcdc_buffer).
DataSource = 'NoAcqSource' %(or []) simulates no data source, requested data will all be filled with zeros (NB: RunMode.RealTime will be forced to true).
>
>
  *Subject: (automatically included if starting using the GUI)
Changed:
<
<
just before BrainStream stops executing your block, BrainStream copies the final state to the OutFolder. The state contains all information BrainStream requires for its internal processing. This Subject's name is incorporated in the name of the corresponding mat-file.
Subject = 'a_subjects_name'
>
>
just before BrainStream stops executing your block, BrainStream copies the final state to the OutFolder. The state contains all information BrainStream requires for its internal processing. This Subject's name is incorporated in the name of the corresponding mat-file.
Subject = 'a_subjects_name'

DataSource:

This key is deprecated, define under topic [DataSources] instead.
  SampleRateAfterDecimation:
Changed:
<
<
if incoming raw data needs to be downsampled in time, set this key to the desired value. The ratio between the acquisition sample rate and SampleRateAfterDecimation must be a power of 2 and >= 1, i.e., 1,2,4,8 or 16. BrainStream applies a low-pass filter to the raw data before downsampling and for the filtering step it collects additional samples (0.1s) in order to provide the requested data epoch to the user (without filter edge effects). Be aware of the fact that it introduces a slightly delay in the moment data becomes available to the user. Take notice of the following; if you insert a marker with zero time-delay at the BS_INIT marker and DataSelection begintime=0s., the extra samples required for the decimation filtering moves the start position towards values < 0. This risc exists for every marker which absolute DataSelection begintime effectual becomes a value smaller than 0.1s. Thus in general, the absolute markers timestamp plus begintime should be larger than 0.1s, but only if data is being decimated. (In case no decimation is applied, effectual DataSelection begintimes can be set to t=0 s.)
SampleRateAfterDecimation = 256 % acquisition sample rate then should be 256Hz or 512, or 1024, or 2048 etc.
>
>
This key is deprecated, define in configuration file instead.
 
Line: 28 to 40
 
sets the amount of information that is displayed during processing.
screenoutputlevel = 'ERROR' % (default) only displays errors and approximately every 10 seconds it indicates progress made.
screenoutputlevel = 'INFO' % also displays which markers' actions are currently being processed in Matlab command window.
screenoutputlevel = 'WARNING' % also displays warning messages.
screenoutputlevel = 'DEBUG' % also displays extra information about processed actions (use only in case debugging is required).

RealTime:

Changed:
<
<
use only in case running with an offline data source, i.e., from file or no data at all (DataSource='NoAcqSource'). Set this value to true in order to simulate real-time data processing. Set it to false if offline data processing should be done as quickly as possible.
RealTime = true % (or 1)
>
>
use only in case running with an offline data source, i.e., from file or simulated data. Set this value to true in order to simulate real-time data processing. Set it to false if offline data processing should be done as quickly as possible.
RealTime = true % (or 1)
  Parallel:
set to true to enable parallel processing of markers' actions. In the experiment definition table it needs to be specified which markers actions are allowed to be processed in parallel. See .... for more details.
Parallel = true % (or 1, default = false)
Line: 37 to 49
 
in case BrainStreams parallel running mode is set to true, this key specifies the number of cores BrainStream should utilize for its parallel processing. Every additional core will then run a separate Matlab session. The Matlab session running BrainStream itself will dedicate jobs to these extra `matlab sessions dependent of how users have configured their experiment definition tables. See .... for more details.
Numcores = 4

Cap:

Changed:
<
<
defines which cap will be used at startup. User functions are responsible for changing hdr and current cap information after changing the cap (after spatial downsampling for example)
Cap = 'biosemi_cap256'
Cap = 'biosemi_cap64'
>
>
This key is deprecated. Specify under topic [<datasource>] or [<device>] instead.
  DataType:
defines type of raw data retrieved from BrainStream.
DataType = 'single' (default)
DataType = 'double'
Line: 103 to 115
  <name of client>:
Changed:
<
<
translates client name (descriptive for the actions that execute parallel-wise) into DNS name or ip-number.
client1 = '131.174.123.456'
client2 = 'eegstim.mydomain.nl'
client3 = 'core1' % dedicate/reserve specific core
client4 = 'cores' % BrainStream picks first available core
client5 = 'local' % execute serial-wise (overruled; no parallel execution)

>
>
translates client name (descriptive for the actions that execute parallel-wise) into DNS name or ip-number.
client1 = '131.174.123.456'
client2 = 'eegstim.mydomain.nl'
client3 = 'core1' % dedicate/reserve specific core
client4 = 'cores' % BrainStream picks first available core
client5 = 'local' % execute serial-wise (overruled; no parallel execution)

 
Line: 116 to 128
  StimulusPresentationRemotePath:
Changed:
<
<
defines stimulus presentation folders to add to Matlab path at remote client side.
Note: $REPOSROOT will be replaced by remote clients specific repository root.
StimulusPresentationRemotePath = '$REPOSROOT/external_toolboxes/PsychToolbox'
<---End1--->
>
>
defines stimulus presentation folders to add to Matlab path at remote client side.
Note: $REPOSROOT will be replaced by remote clients specific repository root.
StimulusPresentationRemotePath = '$REPOSROOT/external_toolboxes/PsychToolbox'

[<client>] (name of the client specified under topic [Clients])

Plugins:

cell array of plugin folders to add to the client's Matlab search path

[<datasource>] (name of the data source specified under topic [DataSources])

Cap:

defines which cap will be used for systems that can use multiple caps, e.g. BioSemi. For systems that can use only one cap type, e.g. Emotiv, specify under topic [<device>]. User functions are responsible for changing hdr and current cap information after changing the cap (for example after spatial downsampling).
Cap = 'cap256.txt'
Cap = 'cap64.txt'

[<device>] (name of the acquisition device specified under topic [DataSources])

Cap:

defines which cap will be used for systems that can use only one cap type, e.g. Emotiv. For systems that can use multiple caps, e.g. BioSemi, specify under topic [<datasource>]. User functions are responsible for changing hdr and current cap information after changing the cap (for example after spatial downsampling).
Cap = 'cap_emotiv_epoch.txt'
Cap = 'cap_neurosky_thinkgear.txt'

<---End1--->
 

Revision 2514 Nov 2011 - Main.MarjoleinVanDerWaal

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
<---Start1--->

Topics and keys for block files

Changed:
<
<
Generate current PDF
>
>
Generate current PDF
  In your block files, two topics are always required: RunMode with key DataSource, and Files with keys, ExperimentDefinitionFile and OutFolder. You can add as many topics with corresponding keys as you like as long as you don't use any of the topics used by BrainStream. This is an overview of topics and keys and their meaning. Keys starting with an asterisk are obligatory.
Line: 92 to 92
 

MatlabPathFnc:

Changed:
<
<
specify function to call by BrainStream for setting Matlab path
MatlabPathFnc = 'setREPOSpath('get_app_folders({''myexperiment''}))'
>
>
specify function to call by BrainStream for setting Matlab path
MatlabPathFnc = 'setREPOSpath('get_app_folders({''myexperiment''}))'
 
MatlabPathAdd:
specify list of extra folders to add to Matlab path
MatlabPathAdd = {'/Volumes/code/my_experiments/',fullfile(get_repos_root,'/own_experiments/visual/')}
Line: 103 to 103
  <name of client>:
Changed:
<
<
translates client name (descriptive for the actions that execute parallel-wise) into DNS name or ip-number.
client1 = '131.174.123.456'
client2 = 'eegstim.mydomain.nl'
client3 = 'core1' % dedicate/reserve specific core
client4 = 'cores' % BrainStream picks first available core
client5 = 'local' % execute serial-wise (overruled; no parallel execution)

>
>
translates client name (descriptive for the actions that execute parallel-wise) into DNS name or ip-number.
client1 = '131.174.123.456'
client2 = 'eegstim.mydomain.nl'
client3 = 'core1' % dedicate/reserve specific core
client4 = 'cores' % BrainStream picks first available core
client5 = 'local' % execute serial-wise (overruled; no parallel execution)

 
Line: 112 to 112
  StimulusPresentationSource:
Changed:
<
<
defines stimulus presentation source
StimulusPresentationSource = 'Logic' % (default)
StimuluspresentationSource = 'PsychToolBox'
StimuluspresentationSource = 'PsychToolBox2' % uses BrainStreams parallel processing option

>
>
defines stimulus presentation source
StimulusPresentationSource = 'Logic' % (default)
StimuluspresentationSource = 'PsychToolBox'
StimuluspresentationSource = 'PsychToolBox2' % uses BrainStreams parallel processing option

  StimulusPresentationRemotePath:

Revision 2414 Nov 2011 - Main.MarjoleinVanDerWaal

Line: 1 to 1
Changed:
<
<
META TOPICPARENT name="DocsSectionsGettingStarted"
>
>
META TOPICPARENT name="WebHome"
 
<---Start1--->

Topics and keys for block files

Line: 107 to 107
 
Changed:
<
<
[StimulusPresentation]
>
>
[BrainStream.StimulusPresentation]
 

StimulusPresentationSource:

Line: 116 to 116
  StimulusPresentationRemotePath:
Changed:
<
<
defines stimulus presentation folders to add to Matlab path at remote client side.
Note: $REPOSROOT will be replaced by remote clients specific repository root.
StimulusPresentationRemotePath = '$REPOSROOT/external_toolboxes/PsychToolbox'

<!---End1--->

<---End1--->
>
>
defines stimulus presentation folders to add to Matlab path at remote client side.
Note: $REPOSROOT will be replaced by remote clients specific repository root.
StimulusPresentationRemotePath = '$REPOSROOT/external_toolboxes/PsychToolbox'
<---End1--->
 
<-- 
  • Access control
    • Set DENYTOPICVIEW =
-->
\ No newline at end of file
Added:
>
>
META TOPICMOVED by="MarjoleinVanDerWaal" date="1321266922" from="BrainStream.BlockFile" to="BrainStreamDocs.DocsSectionsBlockFile"

Revision 2314 Oct 2011 - Main.MarjoleinVanDerWaal

Line: 1 to 1
 
META TOPICPARENT name="DocsSectionsGettingStarted"
<---Start1--->

Topics and keys for block files

Line: 56 to 56
 
defines path to location where BrainStream can store output. This key is obligatory.
OutFolder = '/Volumes/bci_data/my_experiment/'

*ExperimentDefinitionFile:

Changed:
<
<
the file that defines the experiment to run. This key is obligatory.
ExperimentDefinitionFile = '/Volumes/bci_stims/my_experiment/myblock.xls'

>
>
the file containing the experiment definition tables (.xls or .edt). This key is obligatory.
ExperimentDefinitionFile = '/Volumes/bci_stims/my_experiment/myblock.xls'

  ExperimentDefinitionData:
Changed:
<
<
defines in which table or sheet BrainStream can find information about which markers request data for their actions.
ExperimentDefinitionData = 'DataSelection' % (=default)

>
>
defines in which table or sheet BrainStream can find information about which markers request data for their actions.
ExperimentDefinitionData = 'DataSelection' % (=default)

  ExperimentDefinitionSubFile:
Changed:
<
<
defines from which table or sheet BrainStream should start reading markers' actions.
ExperimentDefinitionSubFile = 'Actions' % (=default)

DataFile (deprecated!, don't use these keys, use RunMode.DataSource instead)
DataFileDir (deprecated!, don't use these keys, use RunMode.DataSource instead)
>
>
defines from which table or sheet BrainStream should start reading markers' actions.
ExperimentDefinitionSubFile = 'Actions' % (=default)

DataFile (deprecated!, don't use these keys, use RunMode.DataSource instead)
DataFileDir (deprecated!, don't use these keys, use RunMode.DataSource instead)
  StimulusFile:
defines Logic stimulus presentation file
StimulusFile = '/Volumes/bci_stims/my_experiment/logic/myblock.lso'

Revision 2210 Oct 2011 - Main.MarjoleinVanDerWaal

Line: 1 to 1
 
META TOPICPARENT name="DocsSectionsGettingStarted"
<---Start1--->

Topics and keys for block files

Added:
>
>
Generate current PDF
 In your block files, two topics are always required: RunMode with key DataSource, and Files with keys, ExperimentDefinitionFile and OutFolder. You can add as many topics with corresponding keys as you like as long as you don't use any of the topics used by BrainStream. This is an overview of topics and keys and their meaning. Keys starting with an asterisk are obligatory.

Revision 2104 Oct 2011 - Main.MarjoleinVanDerWaal

Line: 1 to 1
 
META TOPICPARENT name="DocsSectionsGettingStarted"
<---Start1--->

Topics and keys for block files

Changed:
<
<
The block file (i.e. .blk file) is the starting point for BrainStream. From this file, it reads all information required to initiate the experiment block in the platform. The format of the file is according to the windows ini-file style with topics enclosed in brackets and subsequent lines to define keys that belong to this topic. If another bracketed line is encountered, a new topic is started and additional lines will add keys to this new topic. Two topics are always required: RunMode with key DataSource, and Files with keys, ExperimentDefinitionFile and OutFolder. You can add as many topics with corresponding keys as you like as long as you don't use any of the topics used by BrainStream. Below you find a complete overview of topics and keys and their meaning (keys starting with an asterisk are obligate):
>
>
In your block files, two topics are always required: RunMode with key DataSource, and Files with keys, ExperimentDefinitionFile and OutFolder. You can add as many topics with corresponding keys as you like as long as you don't use any of the topics used by BrainStream. This is an overview of topics and keys and their meaning. Keys starting with an asterisk are obligatory.
 
Line: 11 to 11
 

*DataSource:

Changed:
<
<
defines what source is responsible for supplying the raw data to BrainStream. This key is obligatory.
DataSource = 'BioSemiAcq' % BioSemi's Active2.
DataSource = '/my_data/filename.ext' % specify any file supported by fieldtrip/FileIO (also fcdc_buffer).
DataSource = 'NoAcqSource' %(or []) simulates no data source, requested data will all be filled with zeros (NB: RunMode.RealTime will be forced to true).
>
>
defines what source is responsible for supplying the raw data to BrainStream. This key is obligatory.
DataSource = 'BioSemiAcq' % BioSemi's Active2.
DataSource = '/my_data/filename.ext' % specify any file supported by fieldtrip/FileIO (also fcdc_buffer).
DataSource = 'NoAcqSource' %(or []) simulates no data source, requested data will all be filled with zeros (NB: RunMode.RealTime will be forced to true).
  *Subject: (automatically included if starting using the GUI)
Changed:
<
<
just before BrainStream stops executing your block, BrainStream copies the final state to the OutFolder. The state contains all information BrainStream requires for its internal processing. This Subject's name is incorporated in the name of the corresponding mat-file.
Subject = 'a_subjects_name'
>
>
just before BrainStream stops executing your block, BrainStream copies the final state to the OutFolder. The state contains all information BrainStream requires for its internal processing. This Subject's name is incorporated in the name of the corresponding mat-file.
Subject = 'a_subjects_name'
  SampleRateAfterDecimation:
Changed:
<
<
if incoming raw data needs to be downsampled in time, set this key to the desired value. The ratio between the acquisition sample rate and SampleRateAfterDecimation must be a power of 2 and >= 1, i.e., 1,2,4,8 or 16. BrainStream applies a low-pass filter to the raw data before downsampling and for the filtering step it collects additional samples (0.1s) in order to provide the requested data epoch to the user (without filter edge effects). Be aware of the fact that it introduces a slightly delay in the moment data becomes available to the user. Take notice of the following; if you insert a marker with zero time-delay at the BS_INIT marker and DataSelection begintime=0s., the extra samples required for the decimation filtering moves the start position towards values < 0. This risc exists for every marker which absolute DataSelection begintime effectual becomes a value smaller than 0.1s. Thus in general, the absolute markers timestamp plus begintime should be larger than 0.1s, but only if data is being decimated. (In case no decimation is applied, effectual DataSelection begintimes can be set to t=0 s.)
SampleRateAfterDecimation = 256 % acquisition sample rate then should be 256Hz or 512, or 1024, or 2048 etc.
>
>
if incoming raw data needs to be downsampled in time, set this key to the desired value. The ratio between the acquisition sample rate and SampleRateAfterDecimation must be a power of 2 and >= 1, i.e., 1,2,4,8 or 16. BrainStream applies a low-pass filter to the raw data before downsampling and for the filtering step it collects additional samples (0.1s) in order to provide the requested data epoch to the user (without filter edge effects). Be aware of the fact that it introduces a slightly delay in the moment data becomes available to the user. Take notice of the following; if you insert a marker with zero time-delay at the BS_INIT marker and DataSelection begintime=0s., the extra samples required for the decimation filtering moves the start position towards values < 0. This risc exists for every marker which absolute DataSelection begintime effectual becomes a value smaller than 0.1s. Thus in general, the absolute markers timestamp plus begintime should be larger than 0.1s, but only if data is being decimated. (In case no decimation is applied, effectual DataSelection begintimes can be set to t=0 s.)
SampleRateAfterDecimation = 256 % acquisition sample rate then should be 256Hz or 512, or 1024, or 2048 etc.
 
Line: 25 to 25
 screenoutputlevel:
sets the amount of information that is displayed during processing.
screenoutputlevel = 'ERROR' % (default) only displays errors and approximately every 10 seconds it indicates progress made.
screenoutputlevel = 'INFO' % also displays which markers' actions are currently being processed in Matlab command window.
screenoutputlevel = 'WARNING' % also displays warning messages.
screenoutputlevel = 'DEBUG' % also displays extra information about processed actions (use only in case debugging is required).
Deleted:
<
<
TriggerSource:
only used in case data source is FileIO via fcdc_buffer via BCI2000. In this way, incoming markers can be managed directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event.
NB, last channel is assumed to be the trigger channel!!!!
TriggerSource = 'trigger' % (default = 'default')

TriggerDef:

defines how trigger channel information should be translated into marker information.
TriggerDef = 'trigger_definitions.txt'

DataFormat:

only used in case data source is FileIO via fcdc_buffer via BCI2000. This way it is possible to manage incoming markers directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event. Since the actual data acquisition source can be any BCI2000 supported device, DataFormat should be defined so that BrainStream knows how to handle incoming trigger data.
DataFormat = 'biosemi_bdf' % currently the only supported one using BCI2000 via FileIO. (warning, still needs to solve trigger channel filtering issue)
 RealTime:
use only in case running with an offline data source, i.e., from file or no data at all (DataSource='NoAcqSource'). Set this value to true in order to simulate real-time data processing. Set it to false if offline data processing should be done as quickly as possible.
RealTime = true % (or 1)
Line: 41 to 32
 
set to true to enable parallel processing of markers' actions. In the experiment definition table it needs to be specified which markers actions are allowed to be processed in parallel. See .... for more details.
Parallel = true % (or 1, default = false)

NumCores:

Changed:
<
<
in case BrainStreams parallel running mode is set to true, this key specifies the number of cores BrainStream should utilize for its parallel processing. Every additional core will then run a separate Matlab session. The Matlab session running BrainStream itself will dedicate jobs to these extra `matlab sessions dependent of how users have configured their experiment definition tables. See .... for more details.
Numcores = 4

StimulusPresentationSource:

Note: moved to topic StimulusPresentation

RecordStartIndex:

defines from which record to start reading the file (only DataSource=BDFFile)
RecordStartIndex = 1 % (default) only used in case data source is a biosemi .bdf file
>
>
in case BrainStreams parallel running mode is set to true, this key specifies the number of cores BrainStream should utilize for its parallel processing. Every additional core will then run a separate Matlab session. The Matlab session running BrainStream itself will dedicate jobs to these extra `matlab sessions dependent of how users have configured their experiment definition tables. See .... for more details.
Numcores = 4
  Cap:
defines which cap will be used at startup. User functions are responsible for changing hdr and current cap information after changing the cap (after spatial downsampling for example)
Cap = 'biosemi_cap256'
Cap = 'biosemi_cap64'
Deleted:
<
<
CopyStimFiles:
Set to true (default) if stimulus files need to be copied from bci_stims volume to the local stimulus presentation computer.
CopyStimFiles = 1
(warning: CAI-specific, not yet for external users)

LoadStimulusFile:

set to true (default) to start Logic and load stimulus presentation file.
=LoadStimulusFile = 1
(warning: CAI-specific, not yet for external users)
 DataType:
defines type of raw data retrieved from BrainStream.
DataType = 'single' (default)
DataType = 'double'
Line: 72 to 51
 

*OutFolder:

Changed:
<
<
defines path to location where BrainStream can store output. This key is obligatory.
OutFolder = '/Volumes/bci_data/my_experiment/'

>
>
defines path to location where BrainStream can store output. This key is obligatory.
OutFolder = '/Volumes/bci_data/my_experiment/'

  *ExperimentDefinitionFile:
the file that defines the experiment to run. This key is obligatory.
ExperimentDefinitionFile = '/Volumes/bci_stims/my_experiment/myblock.xls'

Revision 2030 Sep 2011 - Main.MarjoleinVanDerWaal

Line: 1 to 1
 
META TOPICPARENT name="DocsSectionsGettingStarted"
<---Start1--->

Topics and keys for block files

Revision 1927 Sep 2011 - Main.MarjoleinVanDerWaal

Line: 1 to 1
 
META TOPICPARENT name="DocsSectionsGettingStarted"
<---Start1--->
Added:
>
>

Topics and keys for block files

  The block file (i.e. .blk file) is the starting point for BrainStream. From this file, it reads all information required to initiate the experiment block in the platform. The format of the file is according to the windows ini-file style with topics enclosed in brackets and subsequent lines to define keys that belong to this topic. If another bracketed line is encountered, a new topic is started and additional lines will add keys to this new topic. Two topics are always required: RunMode with key DataSource, and Files with keys, ExperimentDefinitionFile and OutFolder. You can add as many topics with corresponding keys as you like as long as you don't use any of the topics used by BrainStream. Below you find a complete overview of topics and keys and their meaning (keys starting with an asterisk are obligate):

Revision 1827 Sep 2011 - Main.MarjoleinVanDerWaal

Line: 1 to 1
 
META TOPICPARENT name="DocsSectionsGettingStarted"
<---Start1--->
Line: 10 to 10
 

*DataSource:

Changed:
<
<
defines what source is responsible for supplying the raw data to BrainStream. This key is obligatory.
DataSource = 'BioSemiAcq' % BioSemi's Active2.
DataSource = '/my_data/filename.ext' % specify any file supported by fieldtrip/FileIO (also fcdc_buffer).
DataSource = 'NoAcqSource' %(or []) simulates no data source, requested data will all be filled with zeros (NB: RunMode.RealTime will be forced to true).

>
>
defines what source is responsible for supplying the raw data to BrainStream. This key is obligatory.
DataSource = 'BioSemiAcq' % BioSemi's Active2.
DataSource = '/my_data/filename.ext' % specify any file supported by fieldtrip/FileIO (also fcdc_buffer).
DataSource = 'NoAcqSource' %(or []) simulates no data source, requested data will all be filled with zeros (NB: RunMode.RealTime will be forced to true).
  *Subject: (automatically included if starting using the GUI)
Changed:
<
<
just before BrainStream stops executing your block, BrainStream copies the final state to the OutFolder. The state contains all information BrainStream requires for its internal processing. This Subject's name is incorporated in the name of the corresponding mat-file.
Subject = 'a_subjects_name'

>
>
just before BrainStream stops executing your block, BrainStream copies the final state to the OutFolder. The state contains all information BrainStream requires for its internal processing. This Subject's name is incorporated in the name of the corresponding mat-file.
Subject = 'a_subjects_name'
  SampleRateAfterDecimation:
Changed:
<
<
if incoming raw data needs to be downsampled in time, set this key to the desired value. The ratio between the acquisition sample rate and SampleRateAfterDecimation must be a power of 2 and >= 1, i.e., 1,2,4,8 or 16. BrainStream applies a low-pass filter to the raw data before downsampling and for the filtering step it collects additional samples (0.1s) in order to provide the requested data epoch to the user (without filter edge effects). Be aware of the fact that it introduces a slightly delay in the moment data becomes available to the user. Take notice of the following; if you insert a marker with zero time-delay at the BS_INIT marker and DataSelection begintime=0s., the extra samples required for the decimation filtering moves the start position towards values < 0. This risc exists for every marker which absolute DataSelection begintime effectual becomes a value smaller than 0.1s. Thus in general, the absolute markers timestamp plus begintime should be larger than 0.1s, but only if data is being decimated. (In case no decimation is applied, effectual DataSelection begintimes can be set to t=0 s.)
SampleRateAfterDecimation = 256 % acquisition sample rate then should be 256Hz or 512, or 1024, or 2048 etc.

>
>
if incoming raw data needs to be downsampled in time, set this key to the desired value. The ratio between the acquisition sample rate and SampleRateAfterDecimation must be a power of 2 and >= 1, i.e., 1,2,4,8 or 16. BrainStream applies a low-pass filter to the raw data before downsampling and for the filtering step it collects additional samples (0.1s) in order to provide the requested data epoch to the user (without filter edge effects). Be aware of the fact that it introduces a slightly delay in the moment data becomes available to the user. Take notice of the following; if you insert a marker with zero time-delay at the BS_INIT marker and DataSelection begintime=0s., the extra samples required for the decimation filtering moves the start position towards values < 0. This risc exists for every marker which absolute DataSelection begintime effectual becomes a value smaller than 0.1s. Thus in general, the absolute markers timestamp plus begintime should be larger than 0.1s, but only if data is being decimated. (In case no decimation is applied, effectual DataSelection begintimes can be set to t=0 s.)
SampleRateAfterDecimation = 256 % acquisition sample rate then should be 256Hz or 512, or 1024, or 2048 etc.

  screenoutputlevel:
Changed:
<
<
sets the amount of information that is displayed during processing.
screenoutputlevel = 'ERROR' % (default) only displays errors and approximately every 10 seconds it indicates progress made.
screenoutputlevel = 'INFO' % also displays which markers' actions are currently being processed in Matlab command window.
screenoutputlevel = 'WARNING' % also displays warning messages.
screenoutputlevel = 'DEBUG' % also displays extra information about processed actions (use only in case debugging is required).

>
>
sets the amount of information that is displayed during processing.
screenoutputlevel = 'ERROR' % (default) only displays errors and approximately every 10 seconds it indicates progress made.
screenoutputlevel = 'INFO' % also displays which markers' actions are currently being processed in Matlab command window.
screenoutputlevel = 'WARNING' % also displays warning messages.
screenoutputlevel = 'DEBUG' % also displays extra information about processed actions (use only in case debugging is required).
  TriggerSource:
Changed:
<
<
only used in case data source is FileIO via fcdc_buffer via BCI2000. In this way, incoming markers can be managed directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event.
NB, last channel is assumed to be the trigger channel!!!!
TriggerSource = 'trigger' % (default = 'default')

>
>
only used in case data source is FileIO via fcdc_buffer via BCI2000. In this way, incoming markers can be managed directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event.
NB, last channel is assumed to be the trigger channel!!!!
TriggerSource = 'trigger' % (default = 'default')
  TriggerDef:
Changed:
<
<
defines how trigger channel information should be translated into marker information.
TriggerDef = 'trigger_definitions.txt'

>
>
defines how trigger channel information should be translated into marker information.
TriggerDef = 'trigger_definitions.txt'
  DataFormat:
Changed:
<
<
only used in case data source is FileIO via fcdc_buffer via BCI2000. This way it is possible to manage incoming markers directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event. Since the actual data acquisition source can be any BCI2000 supported device, DataFormat should be defined so that BrainStream knows how to handle incoming trigger data.
DataFormat = 'biosemi_bdf' % currently the only supported one using BCI2000 via FileIO. (warning, still needs to solve trigger channel filtering issue)

>
>
only used in case data source is FileIO via fcdc_buffer via BCI2000. This way it is possible to manage incoming markers directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event. Since the actual data acquisition source can be any BCI2000 supported device, DataFormat should be defined so that BrainStream knows how to handle incoming trigger data.
DataFormat = 'biosemi_bdf' % currently the only supported one using BCI2000 via FileIO. (warning, still needs to solve trigger channel filtering issue)
  RealTime:
Changed:
<
<
use only in case running with an offline data source, i.e., from file or no data at all (DataSource='NoAcqSource'). Set this value to true in order to simulate real-time data processing. Set it to false if offline data processing should be done as quickly as possible.
RealTime = true % (or 1)

>
>
use only in case running with an offline data source, i.e., from file or no data at all (DataSource='NoAcqSource'). Set this value to true in order to simulate real-time data processing. Set it to false if offline data processing should be done as quickly as possible.
RealTime = true % (or 1)
  Parallel:
Changed:
<
<
set to true to enable parallel processing of markers' actions. In the experiment definition table it needs to be specified which markers actions are allowed to be processed in parallel. See .... for more details.
Parallel = true % (or 1, default = false)

>
>
set to true to enable parallel processing of markers' actions. In the experiment definition table it needs to be specified which markers actions are allowed to be processed in parallel. See .... for more details.
Parallel = true % (or 1, default = false)
  NumCores:
Changed:
<
<
in case BrainStreams parallel running mode is set to true, this key specifies the number of cores BrainStream should utilize for its parallel processing. Every additional core will then run a separate Matlab session. The Matlab session running BrainStream itself will dedicate jobs to these extra `matlab sessions dependent of how users have configured their experiment definition tables. See .... for more details.
Numcores = 4

>
>
in case BrainStreams parallel running mode is set to true, this key specifies the number of cores BrainStream should utilize for its parallel processing. Every additional core will then run a separate Matlab session. The Matlab session running BrainStream itself will dedicate jobs to these extra `matlab sessions dependent of how users have configured their experiment definition tables. See .... for more details.
Numcores = 4
  StimulusPresentationSource:
Changed:
<
<
Note: moved to topic StimulusPresentation

>
>
Note: moved to topic StimulusPresentation
  RecordStartIndex:
Changed:
<
<
defines from which record to start reading the file (only DataSource=BDFFile)
RecordStartIndex = 1 % (default) only used in case data source is a biosemi .bdf file
>
>
defines from which record to start reading the file (only DataSource=BDFFile)
RecordStartIndex = 1 % (default) only used in case data source is a biosemi .bdf file
  Cap:
Changed:
<
<
defines which cap will be used at startup. User functions are responsible for changing hdr and current cap information after changing the cap (after spatial downsampling for example)
Cap = 'biosemi_cap256'
Cap = 'biosemi_cap64'

>
>
defines which cap will be used at startup. User functions are responsible for changing hdr and current cap information after changing the cap (after spatial downsampling for example)
Cap = 'biosemi_cap256'
Cap = 'biosemi_cap64'
  CopyStimFiles:
Changed:
<
<
Set to true (default) if stimulus files need to be copied from bci_stims volume to the local stimulus presentation computer.
CopyStimFiles = 1
(warning: CAI-specific, not yet for external users)

>
>
Set to true (default) if stimulus files need to be copied from bci_stims volume to the local stimulus presentation computer.
CopyStimFiles = 1
(warning: CAI-specific, not yet for external users)
  LoadStimulusFile:
Changed:
<
<
set to true (default) to start Logic and load stimulus presentation file.
=LoadStimulusFile = 1
(warning: CAI-specific, not yet for external users)

>
>
set to true (default) to start Logic and load stimulus presentation file.
=LoadStimulusFile = 1
(warning: CAI-specific, not yet for external users)
  DataType:
defines type of raw data retrieved from BrainStream.
DataType = 'single' (default)
DataType = 'double'
Line: 65 to 68
 *ReferenceFolder: (automatically included if starting using the GUI)
defines the folder where the experiment definition file is located. Inside the tables relative path names are translated to absolute path names relative to this ReferenceFolder. This key is obligatory.
ReferenceFolder = '/Volumes/bci_stims/my_experiment/'

Added:
>
>
 *OutFolder:
defines path to location where BrainStream can store output. This key is obligatory.
OutFolder = '/Volumes/bci_data/my_experiment/'

Revision 1727 Sep 2011 - Main.MarjoleinVanDerWaal

Line: 1 to 1
 
META TOPICPARENT name="DocsSectionsGettingStarted"
<---Start1--->

The block file (i.e. .blk file) is the starting point for BrainStream. From this file, it reads all information required to initiate the experiment block in the platform. The format of the file is according to the windows ini-file style with topics enclosed in brackets and subsequent lines to define keys that belong to this topic. If another bracketed line is encountered, a new topic is started and additional lines will add keys to this new topic. Two topics are always required: RunMode with key DataSource, and Files with keys, ExperimentDefinitionFile and OutFolder. You can add as many topics with corresponding keys as you like as long as you don't use any of the topics used by BrainStream. Below you find a complete overview of topics and keys and their meaning (keys starting with an asterisk are obligate):

Added:
>
>
 [RunMode]
Line: 55 to 57
 DataType:
defines type of raw data retrieved from BrainStream.
DataType = 'single' (default)
DataType = 'double'
Added:
>
>
 [Files]
Line: 79 to 83
 ActiviewConfigFile:
defines settings for Actiview to control BioSemi's Active2 acquisition, i.e., number of acquired channels, sample rate etc.
ActiviewConfigFile = 'Actiview_MMMdefault.cfg' % (default)
ActiviewConfigFile = 'Actiview_MMMdefault_cap64.cfg'
ActiviewConfigFile = 'Actiview_MMMaib_cap64.cfg'
ActiviewConfigFile = 'Actiview_MMMaib.cfg'
Added:
>
>
 [BiosemiAcq]
Line: 88 to 94
 Port:
port to connect to on host running Actiview
Port = 5050
Added:
>
>
 [Experiment]
Line: 101 to 109
 
MatlabPathAdd:
specify list of extra folders to add to Matlab path
MatlabPathAdd = {'/Volumes/code/my_experiments/',fullfile(get_repos_root,'/own_experiments/visual/')}
Added:
>
>
 [Clients]
Line: 108 to 118
 
translates client name (descriptive for the actions that execute parallel-wise) into DNS name or ip-number.
client1 = '131.174.123.456'
client2 = 'eegstim.mydomain.nl'
client3 = 'core1' % dedicate/reserve specific core
client4 = 'cores' % BrainStream picks first available core
client5 = 'local' % execute serial-wise (overruled; no parallel execution)

Added:
>
>
 [StimulusPresentation]

Revision 1619 Nov 2009 - Main.PhilipVanDenBroek

Line: 1 to 1
 
META TOPICPARENT name="DocsSectionsGettingStarted"
<---Start1--->
Line: 50 to 50
 
Set to true (default) if stimulus files need to be copied from bci_stims volume to the local stimulus presentation computer.
CopyStimFiles = 1
(warning: CAI-specific, not yet for external users)

LoadStimulusFile:

Changed:
<
<
set to true (default) to start Logic and load stimulus presentation file.
=LoadStimulusFile = 1
(warning: CAI-specific, not yet for external users)

>
>
set to true (default) to start Logic and load stimulus presentation file.
=LoadStimulusFile = 1
(warning: CAI-specific, not yet for external users)

  DataType:
defines type of raw data retrieved from BrainStream.
DataType = 'single' (default)
DataType = 'double'

Revision 1519 Nov 2009 - Main.PhilipVanDenBroek

Line: 1 to 1
 
META TOPICPARENT name="DocsSectionsGettingStarted"
<---Start1--->
Line: 47 to 47
 
defines which cap will be used at startup. User functions are responsible for changing hdr and current cap information after changing the cap (after spatial downsampling for example)
Cap = 'biosemi_cap256'
Cap = 'biosemi_cap64'

CopyStimFiles:

Changed:
<
<
Set to true (default) if stimulus files need to be copied from bci_stims volume to the local stimulus presentation computer.
CopyStimFiles = 1

>
>
Set to true (default) if stimulus files need to be copied from bci_stims volume to the local stimulus presentation computer.
CopyStimFiles = 1
(warning: CAI-specific, not yet for external users)

  LoadStimulusFile:
Changed:
<
<
set to true (default) to start Logic and load stimulus presentation file.
=LoadStimulusFile = 1
>
>
set to true (default) to start Logic and load stimulus presentation file.
=LoadStimulusFile = 1
(warning: CAI-specific, not yet for external users)

DataType:

defines type of raw data retrieved from BrainStream.
DataType = 'single' (default)
DataType = 'double'
  [Files]

Revision 1414 Nov 2009 - Main.PhilipVanDenBroek

Line: 1 to 1
 
META TOPICPARENT name="DocsSectionsGettingStarted"
<---Start1--->
Line: 103 to 103
  <name of client>:
Changed:
<
<
translates client name (descriptive for the actions that execute parallel-wise) into DNS name or ip-number.
client1 = '131.174.123.456'
client2 = 'eegstim.mydomain.nl'
client3 = 'core1' % dedicate/reserve specific core
client4 = 'cores' % BrainStream picks first available core
client5 = 'local' % execute serial-wise (overruled; no parallel execution)
>
>
translates client name (descriptive for the actions that execute parallel-wise) into DNS name or ip-number.
client1 = '131.174.123.456'
client2 = 'eegstim.mydomain.nl'
client3 = 'core1' % dedicate/reserve specific core
client4 = 'cores' % BrainStream picks first available core
client5 = 'local' % execute serial-wise (overruled; no parallel execution)

  [StimulusPresentation]
Line: 114 to 114
  StimulusPresentationRemotePath:
Changed:
<
<
defines stimulus presentation folders to add to Matlab path at remote client side.
Note: $REPOSROOT will be replaced by remote clients specific repository root.
StimulusPresentationRemotePath = '$REPOSROOT/external_toolboxes/PsychToolbox'


>
>
defines stimulus presentation folders to add to Matlab path at remote client side.
Note: $REPOSROOT will be replaced by remote clients specific repository root.
StimulusPresentationRemotePath = '$REPOSROOT/external_toolboxes/PsychToolbox'

<!---End1--->
 

Revision 1310 Nov 2009 - Main.MarianneSeverens

Line: 1 to 1
 
META TOPICPARENT name="DocsSectionsGettingStarted"
Added:
>
>
<---Start1--->
 The block file (i.e. .blk file) is the starting point for BrainStream. From this file, it reads all information required to initiate the experiment block in the platform. The format of the file is according to the windows ini-file style with topics enclosed in brackets and subsequent lines to define keys that belong to this topic. If another bracketed line is encountered, a new topic is started and additional lines will add keys to this new topic. Two topics are always required: RunMode with key DataSource, and Files with keys, ExperimentDefinitionFile and OutFolder. You can add as many topics with corresponding keys as you like as long as you don't use any of the topics used by BrainStream. Below you find a complete overview of topics and keys and their meaning (keys starting with an asterisk are obligate):

[RunMode]

Line: 115 to 117
 
defines stimulus presentation folders to add to Matlab path at remote client side.
Note: $REPOSROOT will be replaced by remote clients specific repository root.
StimulusPresentationRemotePath = '$REPOSROOT/external_toolboxes/PsychToolbox'


Added:
>
>
<---End1--->

<-- 
  • Access control
    • Set DENYTOPICVIEW =
-->
 \ No newline at end of file

Revision 1221 Oct 2009 - Main.PhilipVanDenBroek

Line: 1 to 1
 
META TOPICPARENT name="DocsSectionsGettingStarted"
The block file (i.e. .blk file) is the starting point for BrainStream. From this file, it reads all information required to initiate the experiment block in the platform. The format of the file is according to the windows ini-file style with topics enclosed in brackets and subsequent lines to define keys that belong to this topic. If another bracketed line is encountered, a new topic is started and additional lines will add keys to this new topic. Two topics are always required: RunMode with key DataSource, and Files with keys, ExperimentDefinitionFile and OutFolder. You can add as many topics with corresponding keys as you like as long as you don't use any of the topics used by BrainStream. Below you find a complete overview of topics and keys and their meaning (keys starting with an asterisk are obligate):
Line: 12 to 12
 
just before BrainStream stops executing your block, BrainStream copies the final state to the OutFolder. The state contains all information BrainStream requires for its internal processing. This Subject's name is incorporated in the name of the corresponding mat-file.
Subject = 'a_subjects_name'

SampleRateAfterDecimation:

Changed:
<
<
if incoming raw data needs to be downsampled in time, set this key to the desired value. The ratio between the acquisition sample rate and SampleRateAfterDecimation must be a power of 2 and >= 1, i.e., 1,2,4,8 or 16. BrainStream applies a low-pass filter to the raw data before downsampling and for the filtering step it collects additional samples in order to provide the requested data epoch to the user (without filter edge effects). Be aware of the fact that it introduces a slightly delay in the moment data becomes available to the user.
SampleRateAfterDecimation = 256 % acquisition sample rate then should be 256Hz or 512, or 1024, or 2048 etc.

>
>
if incoming raw data needs to be downsampled in time, set this key to the desired value. The ratio between the acquisition sample rate and SampleRateAfterDecimation must be a power of 2 and >= 1, i.e., 1,2,4,8 or 16. BrainStream applies a low-pass filter to the raw data before downsampling and for the filtering step it collects additional samples (0.1s) in order to provide the requested data epoch to the user (without filter edge effects). Be aware of the fact that it introduces a slightly delay in the moment data becomes available to the user. Take notice of the following; if you insert a marker with zero time-delay at the BS_INIT marker and DataSelection begintime=0s., the extra samples required for the decimation filtering moves the start position towards values < 0. This risc exists for every marker which absolute DataSelection begintime effectual becomes a value smaller than 0.1s. Thus in general, the absolute markers timestamp plus begintime should be larger than 0.1s, but only if data is being decimated. (In case no decimation is applied, effectual DataSelection begintimes can be set to t=0 s.)
SampleRateAfterDecimation = 256 % acquisition sample rate then should be 256Hz or 512, or 1024, or 2048 etc.

  screenoutputlevel:
sets the amount of information that is displayed during processing.
screenoutputlevel = 'ERROR' % (default) only displays errors and approximately every 10 seconds it indicates progress made.
screenoutputlevel = 'INFO' % also displays which markers' actions are currently being processed in Matlab command window.
screenoutputlevel = 'WARNING' % also displays warning messages.
screenoutputlevel = 'DEBUG' % also displays extra information about processed actions (use only in case debugging is required).

Revision 1120 Aug 2009 - Main.MoniekLijster

Line: 1 to 1
 
META TOPICPARENT name="DocsSectionsGettingStarted"
Changed:
<
<
The block file is the starting point for BrainStream, from this file it reads all information required to initiate the experiment block in the platform. The format of the file is according to the windows ini-file style with topics enclosed in brackets and subsequent lines to define keys that belong to this topic. If another bracketed line is encountered, a new topic is started and additional lines will add keys to this new topic. Two topics are always required: RunMode with key DataSource, and Files with keys, ExperimentDefinitionFile and OutFolder. Users can add as many topics with corresponding keys as they like as long as they don't use any of the topics used by BrainStream.

A complete overview of topics and keys and their meaning (keys starting with an asterisk are obligate):
>
>
The block file (i.e. .blk file) is the starting point for BrainStream. From this file, it reads all information required to initiate the experiment block in the platform. The format of the file is according to the windows ini-file style with topics enclosed in brackets and subsequent lines to define keys that belong to this topic. If another bracketed line is encountered, a new topic is started and additional lines will add keys to this new topic. Two topics are always required: RunMode with key DataSource, and Files with keys, ExperimentDefinitionFile and OutFolder. You can add as many topics with corresponding keys as you like as long as you don't use any of the topics used by BrainStream. Below you find a complete overview of topics and keys and their meaning (keys starting with an asterisk are obligate):
  [RunMode]

*DataSource:

Changed:
<
<
defines what source is responsible for supplying the raw data to BrainStream.
DataSource = 'BioSemiAcq' % BioSemi's Active2.
DataSource = '/my_data/filename.ext' % specify any file supported by fieldtrip/FileIO (also fcdc_buffer).
DataSource = 'NoAcqSource' %(or []) simulates no data source, requested data will al be filled with zeros (NB: RunMode.RealTime will be forced to true).

>
>
defines what source is responsible for supplying the raw data to BrainStream. This key is obligatory.
DataSource = 'BioSemiAcq' % BioSemi's Active2.
DataSource = '/my_data/filename.ext' % specify any file supported by fieldtrip/FileIO (also fcdc_buffer).
DataSource = 'NoAcqSource' %(or []) simulates no data source, requested data will all be filled with zeros (NB: RunMode.RealTime will be forced to true).

  *Subject: (automatically included if starting using the GUI)
Changed:
<
<
at the end, just before BrainStream stops executing your block, BrainStream copies the final state to the OutFolder. The state contains all information BrainStream requires for its internal processing. This Subject's name is incorporated in the name of the corresponding mat-file.
Subject = 'a_subjects_name'

>
>
just before BrainStream stops executing your block, BrainStream copies the final state to the OutFolder. The state contains all information BrainStream requires for its internal processing. This Subject's name is incorporated in the name of the corresponding mat-file.
Subject = 'a_subjects_name'

  SampleRateAfterDecimation:
if incoming raw data needs to be downsampled in time, set this key to the desired value. The ratio between the acquisition sample rate and SampleRateAfterDecimation must be a power of 2 and >= 1, i.e., 1,2,4,8 or 16. BrainStream applies a low-pass filter to the raw data before downsampling and for the filtering step it collects additional samples in order to provide the requested data epoch to the user (without filter edge effects). Be aware of the fact that it introduces a slightly delay in the moment data becomes available to the user.
SampleRateAfterDecimation = 256 % acquisition sample rate then should be 256Hz or 512, or 1024, or 2048 etc.

Line: 18 to 18
 
sets the amount of information that is displayed during processing.
screenoutputlevel = 'ERROR' % (default) only displays errors and approximately every 10 seconds it indicates progress made.
screenoutputlevel = 'INFO' % also displays which markers' actions are currently being processed in Matlab command window.
screenoutputlevel = 'WARNING' % also displays warning messages.
screenoutputlevel = 'DEBUG' % also displays extra information about processed actions (use only in case debugging is required).

TriggerSource:

Changed:
<
<
only used in case data source is FileIO via fcdc_buffer via BCI2000. This way it is possible to manage incoming markers directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event.
NB, last channel is assumed to be the trigger channel!!!!
TriggerSource = 'trigger' % (default = 'default')

>
>
only used in case data source is FileIO via fcdc_buffer via BCI2000. In this way, incoming markers can be managed directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event.
NB, last channel is assumed to be the trigger channel!!!!
TriggerSource = 'trigger' % (default = 'default')

  TriggerDef:
defines how trigger channel information should be translated into marker information.
TriggerDef = 'trigger_definitions.txt'

Line: 54 to 54
 

*ReferenceFolder: (automatically included if starting using the GUI)

Changed:
<
<
defines the folder where the experiment definition file is located. Inside the tables relative path names are translated to absolute path names relative to this ReferenceFolder. This key must be defined.
ReferenceFolder = '/Volumes/bci_stims/my_experiment/'

>
>
defines the folder where the experiment definition file is located. Inside the tables relative path names are translated to absolute path names relative to this ReferenceFolder. This key is obligatory.
ReferenceFolder = '/Volumes/bci_stims/my_experiment/'

  *OutFolder:
Changed:
<
<
defines path to location where BrainStream can store output. This key must be defined.
OutFolder = '/Volumes/bci_data/my_experiment/'

>
>
defines path to location where BrainStream can store output. This key is obligatory.
OutFolder = '/Volumes/bci_data/my_experiment/'

  *ExperimentDefinitionFile:
Changed:
<
<
the file that defines the experiment to run.
ExperimentDefinitionFile = '/Volumes/bci_stims/my_experiment/myblock.xls'

>
>
the file that defines the experiment to run. This key is obligatory.
ExperimentDefinitionFile = '/Volumes/bci_stims/my_experiment/myblock.xls'

  ExperimentDefinitionData:
defines in which table or sheet BrainStream can find information about which markers request data for their actions.
ExperimentDefinitionData = 'DataSelection' % (=default)

Line: 87 to 87
 

*Block:

Changed:
<
<
name descriptive for the sub-experiment to run
Block = 'speller'
>
>
name descriptive for the sub-experiment (i.e. block) to run
Block = 'speller'
 
Line: 101 to 101
  <name of client>:
Changed:
<
<
translates client name (descriptive for the actions that execute parallel-wise) into DNS name or ip-number.
client1 = '131.174.123.456'
client2 = 'eegstim.mydomain.nl'
client3 = 'core1' % dedicate/reserve specific core
client4 = 'cores' % BrainStream picks first available core
client5 = 'local' % execute serial-wise (overruled; no parallel execution)
>
>
translates client name (descriptive for the actions that execute parallel-wise) into DNS name or ip-number.
client1 = '131.174.123.456'
client2 = 'eegstim.mydomain.nl'
client3 = 'core1' % dedicate/reserve specific core
client4 = 'cores' % BrainStream picks first available core
client5 = 'local' % execute serial-wise (overruled; no parallel execution)
  [StimulusPresentation]

StimulusPresentationSource:

Changed:
<
<
defines stimulus presentation source
StimulusPresentationSource = 'Logic' % (default)
StimuluspresentationSource = 'PsychToolBox'
StimuluspresentationSource = 'PsychToolBox2' % uses BrainStreams parallel processing option

>
>
defines stimulus presentation source
StimulusPresentationSource = 'Logic' % (default)
StimuluspresentationSource = 'PsychToolBox'
StimuluspresentationSource = 'PsychToolBox2' % uses BrainStreams parallel processing option

  StimulusPresentationRemotePath:
Changed:
<
<
defines stimulus presentation folders to add to Matlab path at remote client side.
Note: $REPOSROOT will be replaced by remote clients specific repository root.
StimulusPresentationRemotePath = '$REPOSROOT/external_toolboxes/PsychToolbox'


>
>
defines stimulus presentation folders to add to Matlab path at remote client side.
Note: $REPOSROOT will be replaced by remote clients specific repository root.
StimulusPresentationRemotePath = '$REPOSROOT/external_toolboxes/PsychToolbox'


  \ No newline at end of file

Revision 1012 Aug 2009 - Main.PhilipVanDenBroek

Line: 1 to 1
 
META TOPICPARENT name="DocsSectionsGettingStarted"
The block file is the starting point for BrainStream, from this file it reads all information required to initiate the experiment block in the platform. The format of the file is according to the windows ini-file style with topics enclosed in brackets and subsequent lines to define keys that belong to this topic. If another bracketed line is encountered, a new topic is started and additional lines will add keys to this new topic. Two topics are always required: RunMode with key DataSource, and Files with keys, ExperimentDefinitionFile and OutFolder. Users can add as many topics with corresponding keys as they like as long as they don't use any of the topics used by BrainStream.

A complete overview of topics and keys and their meaning (keys starting with an asterisk are obligate):
Line: 101 to 101
  <name of client>:
Changed:
<
<
translates client name (descriptive for the actions that execute parallel-wise) into DNS name or ip-number.
client1 = '131.174.123.456'
client2 = 'eegstim.mydomain.nl'
client3 = 'core1' % dedicate/reserve specific core
client4 = 'cores' % BrainStream picks first available core
client5 = 'local' % execute serial-wise (overruled; no parallel execution)
>
>
translates client name (descriptive for the actions that execute parallel-wise) into DNS name or ip-number.
client1 = '131.174.123.456'
client2 = 'eegstim.mydomain.nl'
client3 = 'core1' % dedicate/reserve specific core
client4 = 'cores' % BrainStream picks first available core
client5 = 'local' % execute serial-wise (overruled; no parallel execution)
  [StimulusPresentation]

Revision 911 Aug 2009 - Main.PhilipVanDenBroek

Line: 1 to 1
 
META TOPICPARENT name="DocsSectionsGettingStarted"
The block file is the starting point for BrainStream, from this file it reads all information required to initiate the experiment block in the platform. The format of the file is according to the windows ini-file style with topics enclosed in brackets and subsequent lines to define keys that belong to this topic. If another bracketed line is encountered, a new topic is started and additional lines will add keys to this new topic. Two topics are always required: RunMode with key DataSource, and Files with keys, ExperimentDefinitionFile and OutFolder. Users can add as many topics with corresponding keys as they like as long as they don't use any of the topics used by BrainStream.

A complete overview of topics and keys and their meaning (keys starting with an asterisk are obligate):
Line: 99 to 99
 [Clients]
Changed:
<
<
<name of client>: client name descriptive for the actions that execute parallel-wise
>
>
<name of client>:
 
Changed:
<
<
client1 = '131.174.123.456'
client2 = 'eegstim.mydomain.nl'
client3 = 'core1' % dedicate/reserve specific core
client4 = 'cores' % BrainStream picks first available core
client5 = 'local' % execute serial-wise (overruled; no parallel execution)
>
>
translates client name (descriptive for the actions that execute parallel-wise) into DNS name or ip-number.
client1 = '131.174.123.456'
client2 = 'eegstim.mydomain.nl'
client3 = 'core1' % dedicate/reserve specific core
client4 = 'cores' % BrainStream picks first available core
client5 = 'local' % execute serial-wise (overruled; no parallel execution)
  [StimulusPresentation]
Changed:
<
<
>
>
 StimulusPresentationSource:
Changed:
<
<
defines stimulus presentation source.
StimulusPresentationSource = 'Logic' % (default)
StimuluspresentationSource = 'PsychToolBox'

StimulusPresentationRemotePath:
defines path of folders on remote client that contain stimulus presentation required functions that need to be added to the Matlab path.
>
>
 
Added:
>
>
defines stimulus presentation source
StimulusPresentationSource = 'Logic' % (default)
StimuluspresentationSource = 'PsychToolBox'
StimuluspresentationSource = 'PsychToolBox2' % uses BrainStreams parallel processing option

StimulusPresentationRemotePath:

 
Changed:
<
<
>
>
defines stimulus presentation folders to add to Matlab path at remote client side.
Note: $REPOSROOT will be replaced by remote clients specific repository root.
StimulusPresentationRemotePath = '$REPOSROOT/external_toolboxes/PsychToolbox'

  \ No newline at end of file

Revision 811 Aug 2009 - Main.PhilipVanDenBroek

Line: 1 to 1
 
META TOPICPARENT name="DocsSectionsGettingStarted"
The block file is the starting point for BrainStream, from this file it reads all information required to initiate the experiment block in the platform. The format of the file is according to the windows ini-file style with topics enclosed in brackets and subsequent lines to define keys that belong to this topic. If another bracketed line is encountered, a new topic is started and additional lines will add keys to this new topic. Two topics are always required: RunMode with key DataSource, and Files with keys, ExperimentDefinitionFile and OutFolder. Users can add as many topics with corresponding keys as they like as long as they don't use any of the topics used by BrainStream.

A complete overview of topics and keys and their meaning (keys starting with an asterisk are obligate):
Line: 36 to 36
 
in case BrainStreams parallel running mode is set to true, this key specifies the number of cores BrainStream should utilize for its parallel processing. Every additional core will then run a separate Matlab session. The Matlab session running BrainStream itself will dedicate jobs to these extra `matlab sessions dependent of how users have configured their experiment definition tables. See .... for more details.
Numcores = 4

StimulusPresentationSource:

Changed:
<
<
defines stimulus presentation source.
StimulusPresentationSource = 'Logic' % (default)
StimuluspresentationSource = 'PsychToolBox'

>
>
Note: moved to topic StimulusPresentation

  RecordStartIndex:
defines from which record to start reading the file (only DataSource=BDFFile)
RecordStartIndex = 1 % (default) only used in case data source is a biosemi .bdf file
Line: 89 to 89
 *Block:
name descriptive for the sub-experiment to run
Block = 'speller'
Changed:
<
<
MatlabPathFnc:
>
>
 
Changed:
<
<
specify function to call by BrainStream for setting Matlab path

MatlabPathFnc = 'setREPOSpath('get_app_folders({''myexperiment''}))'
>
>
MatlabPathFnc:
specify function to call by BrainStream for setting Matlab path
MatlabPathFnc = 'setREPOSpath('get_app_folders({''myexperiment''}))'
 
MatlabPathAdd:
specify list of extra folders to add to Matlab path
MatlabPathAdd = {'/Volumes/code/my_experiments/',fullfile(get_repos_root,'/own_experiments/visual/')}
Line: 102 to 101
  <name of client>: client name descriptive for the actions that execute parallel-wise
Changed:
<
<
client1 = '131.174.123.456'
client2 = 'eegstim.mydomain.nl'
client3 = 'core1' % dedicate/reserve specific core
client4 = 'cores' % BrainStream picks first available core
client5 = 'local' % execute serial-wise (overruled; no parallel execution)

>
>
client1 = '131.174.123.456'
client2 = 'eegstim.mydomain.nl'
client3 = 'core1' % dedicate/reserve specific core
client4 = 'cores' % BrainStream picks first available core
client5 = 'local' % execute serial-wise (overruled; no parallel execution)

[StimulusPresentation]

StimulusPresentationSource: defines stimulus presentation source.
StimulusPresentationSource = 'Logic' % (default)
StimuluspresentationSource = 'PsychToolBox'

StimulusPresentationRemotePath:
defines path of folders on remote client that contain stimulus presentation required functions that need to be added to the Matlab path.
 

Revision 710 Aug 2009 - Main.PhilipVanDenBroek

Line: 1 to 1
 
META TOPICPARENT name="DocsSectionsGettingStarted"
The block file is the starting point for BrainStream, from this file it reads all information required to initiate the experiment block in the platform. The format of the file is according to the windows ini-file style with topics enclosed in brackets and subsequent lines to define keys that belong to this topic. If another bracketed line is encountered, a new topic is started and additional lines will add keys to this new topic. Two topics are always required: RunMode with key DataSource, and Files with keys, ExperimentDefinitionFile and OutFolder. Users can add as many topics with corresponding keys as they like as long as they don't use any of the topics used by BrainStream.

A complete overview of topics and keys and their meaning (keys starting with an asterisk are obligate):

[RunMode]

Changed:
<
<
>
>
  *DataSource:
Changed:
<
<
defines what source is responsible for supplying the raw data to BrainStream.
DataSource = 'BioSemiAcq' % BioSemi's Active2.
DataSource = '/my_data/filename.ext' % specify any file supported by fieldtrip/FileIO (also fcdc_buffer).
DataSource = 'NoAcqSource' %(or []) simulates no data source, requested data will al be filled with zeros (NB: RunMode.RealTime will be forced to true).

>
>
defines what source is responsible for supplying the raw data to BrainStream.
DataSource = 'BioSemiAcq' % BioSemi's Active2.
DataSource = '/my_data/filename.ext' % specify any file supported by fieldtrip/FileIO (also fcdc_buffer).
DataSource = 'NoAcqSource' %(or []) simulates no data source, requested data will al be filled with zeros (NB: RunMode.RealTime will be forced to true).

  *Subject: (automatically included if starting using the GUI)
Changed:
<
<
at the end, just before BrainStream stops executing your block, BrainStream copies the final state to the OutFolder. The state contains all information BrainStream requires for its internal processing. This Subject's name is incorporated in the name of the corresponding mat-file.
Subject = 'a_subjects_name'

>
>
at the end, just before BrainStream stops executing your block, BrainStream copies the final state to the OutFolder. The state contains all information BrainStream requires for its internal processing. This Subject's name is incorporated in the name of the corresponding mat-file.
Subject = 'a_subjects_name'

  SampleRateAfterDecimation:
Changed:
<
<
if incoming raw data needs to be downsampled in time, set this key to the desired value. The ratio between the acquisition sample rate and SampleRateAfterDecimation must be a power of 2 and >= 1, i.e., 1,2,4,8 or 16. BrainStream applies a low-pass filter to the raw data before downsampling and for the filtering step it collects additional samples in order to provide the requested data epoch to the user (without filter edge effects). Be aware of the fact that it introduces a slightly delay in the moment data becomes available to the user.
SampleRateAfterDecimation = 256 % acquisition sample rate then should be 256Hz or 512, or 1024, or 2048 etc.

>
>
if incoming raw data needs to be downsampled in time, set this key to the desired value. The ratio between the acquisition sample rate and SampleRateAfterDecimation must be a power of 2 and >= 1, i.e., 1,2,4,8 or 16. BrainStream applies a low-pass filter to the raw data before downsampling and for the filtering step it collects additional samples in order to provide the requested data epoch to the user (without filter edge effects). Be aware of the fact that it introduces a slightly delay in the moment data becomes available to the user.
SampleRateAfterDecimation = 256 % acquisition sample rate then should be 256Hz or 512, or 1024, or 2048 etc.

  screenoutputlevel:
Changed:
<
<
sets the amount of information that is displayed during processing.
screenoutputlevel = 'ERROR' % (default) only displays errors and approximately every 10 seconds it indicates progress made.
screenoutputlevel = 'INFO' % also displays which markers' actions are currently being processed in Matlab command window.
screenoutputlevel = 'WARNING' % also displays warning messages.
screenoutputlevel = 'DEBUG' % also displays extra information about processed actions (use only in case debugging is required).

>
>
sets the amount of information that is displayed during processing.
screenoutputlevel = 'ERROR' % (default) only displays errors and approximately every 10 seconds it indicates progress made.
screenoutputlevel = 'INFO' % also displays which markers' actions are currently being processed in Matlab command window.
screenoutputlevel = 'WARNING' % also displays warning messages.
screenoutputlevel = 'DEBUG' % also displays extra information about processed actions (use only in case debugging is required).

  TriggerSource:
Changed:
<
<
only used in case data source is FileIO via fcdc_buffer via BCI2000. This way it is possible to manage incoming markers directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event.
NB, last channel is assumed to be the trigger channel!!!!
TriggerSource = 'trigger' % (default = 'default')

>
>
only used in case data source is FileIO via fcdc_buffer via BCI2000. This way it is possible to manage incoming markers directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event.
NB, last channel is assumed to be the trigger channel!!!!
TriggerSource = 'trigger' % (default = 'default')

  TriggerDef:
Changed:
<
<
defines how trigger channel information should be translated into marker information.
TriggerDef = 'trigger_definitions.txt'

>
>
defines how trigger channel information should be translated into marker information.
TriggerDef = 'trigger_definitions.txt'

  DataFormat:
Changed:
<
<
only used in case data source is FileIO via fcdc_buffer via BCI2000. This way it is possible to manage incoming markers directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event. Since the actual data acquisition source can be any BCI2000 supported device, DataFormat should be defined so that BrainStream knows how to handle incoming trigger data.
DataFormat = 'biosemi_bdf' % currently the only supported one using BCI2000 via FileIO. (warning, still needs to solve trigger channel filtering issue)

>
>
only used in case data source is FileIO via fcdc_buffer via BCI2000. This way it is possible to manage incoming markers directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event. Since the actual data acquisition source can be any BCI2000 supported device, DataFormat should be defined so that BrainStream knows how to handle incoming trigger data.
DataFormat = 'biosemi_bdf' % currently the only supported one using BCI2000 via FileIO. (warning, still needs to solve trigger channel filtering issue)

  RealTime:
Changed:
<
<
use only in case running with an offline data source, i.e., from file or no data at all (DataSource='NoAcqSource'). Set this value to true in order to simulate real-time data processing. Set it to false if offline data processing should be done as quickly as possible.
RealTime = true % (or 1)

>
>
use only in case running with an offline data source, i.e., from file or no data at all (DataSource='NoAcqSource'). Set this value to true in order to simulate real-time data processing. Set it to false if offline data processing should be done as quickly as possible.
RealTime = true % (or 1)

  Parallel:
Changed:
<
<
set to true to enable parallel processing of markers' actions. In the experiment definition table it needs to be specified which markers actions are allowed to be processed in parallel. See .... for more details.
Parallel = true % (or 1, default = false)

>
>
set to true to enable parallel processing of markers' actions. In the experiment definition table it needs to be specified which markers actions are allowed to be processed in parallel. See .... for more details.
Parallel = true % (or 1, default = false)

  NumCores:
Changed:
<
<
in case BrainStreams parallel running mode is set to true, this key specifies the number of cores BrainStream should utilize for its parallel processing. Every additional core will then run a separate Matlab session. The Matlab session running BrainStream itself will dedicate jobs to these extra `matlab sessions dependent of how users have configured their experiment definition tables. See .... for more details.
Numcores = 4

>
>
in case BrainStreams parallel running mode is set to true, this key specifies the number of cores BrainStream should utilize for its parallel processing. Every additional core will then run a separate Matlab session. The Matlab session running BrainStream itself will dedicate jobs to these extra `matlab sessions dependent of how users have configured their experiment definition tables. See .... for more details.
Numcores = 4

  StimulusPresentationSource:
Changed:
<
<
defines stimulus presentation source.
StimulusPresentationSource = 'Logic' % (default)
StimuluspresentationSource = 'PsychToolBox'

>
>
defines stimulus presentation source.
StimulusPresentationSource = 'Logic' % (default)
StimuluspresentationSource = 'PsychToolBox'

  RecordStartIndex:
Changed:
<
<
defines from which record to start reading the file (only DataSource=BDFFile)
RecordStartIndex = 1 % (default) only used in case data source is a biosemi .bdf file
>
>
defines from which record to start reading the file (only DataSource=BDFFile)
RecordStartIndex = 1 % (default) only used in case data source is a biosemi .bdf file
  Cap:
Changed:
<
<
defines which cap will be used at startup. User functions are responsible for changing hdr and current cap information after changing the cap (after spatial downsampling for example)
Cap = 'biosemi_cap256'
Cap = 'biosemi_cap64'

>
>
defines which cap will be used at startup. User functions are responsible for changing hdr and current cap information after changing the cap (after spatial downsampling for example)
Cap = 'biosemi_cap256'
Cap = 'biosemi_cap64'

  CopyStimFiles:
Changed:
<
<
Set to true (default) if stimulus files need to be copied from bci_stims volume to the local stimulus presentation computer.
CopyStimFiles = 1

>
>
Set to true (default) if stimulus files need to be copied from bci_stims volume to the local stimulus presentation computer.
CopyStimFiles = 1

  LoadStimulusFile:
Changed:
<
<
set to true (default) to start Logic and load stimulus presentation file.
=LoadStimulusFile = 1
>
>
set to true (default) to start Logic and load stimulus presentation file.
=LoadStimulusFile = 1
  [Files]
Changed:
<
<
>
>
  *ReferenceFolder: (automatically included if starting using the GUI)
Changed:
<
<
defines the folder where the experiment definition file is located. Inside the tables relative path names are translated to absolute path names relative to this ReferenceFolder. This key must be defined.
ReferenceFolder = '/Volumes/bci_stims/my_experiment/'

>
>
defines the folder where the experiment definition file is located. Inside the tables relative path names are translated to absolute path names relative to this ReferenceFolder. This key must be defined.
ReferenceFolder = '/Volumes/bci_stims/my_experiment/'

  *OutFolder:
Changed:
<
<
defines path to location where BrainStream can store output. This key must be defined.
OutFolder = '/Volumes/bci_data/my_experiment/'

>
>
defines path to location where BrainStream can store output. This key must be defined.
OutFolder = '/Volumes/bci_data/my_experiment/'

  *ExperimentDefinitionFile:
Changed:
<
<
the file that defines the experiment to run.
ExperimentDefinitionFile = '/Volumes/bci_stims/my_experiment/myblock.xls'

>
>
the file that defines the experiment to run.
ExperimentDefinitionFile = '/Volumes/bci_stims/my_experiment/myblock.xls'

  ExperimentDefinitionData:
Changed:
<
<
defines in which table or sheet BrainStream can find information about which markers request data for their actions.
ExperimentDefinitionData = 'DataSelection' % (=default)

>
>
defines in which table or sheet BrainStream can find information about which markers request data for their actions.
ExperimentDefinitionData = 'DataSelection' % (=default)

  ExperimentDefinitionSubFile:
Changed:
<
<
defines from which table or sheet BrainStream should start reading markers' actions.
ExperimentDefinitionSubFile = 'Actions' % (=default)

DataFile (deprecated!, don't use these keys, use RunMode.DataSource instead)
DataFileDir (deprecated!, don't use these keys, use RunMode.DataSource instead)
>
>
defines from which table or sheet BrainStream should start reading markers' actions.
ExperimentDefinitionSubFile = 'Actions' % (=default)

DataFile (deprecated!, don't use these keys, use RunMode.DataSource instead)
DataFileDir (deprecated!, don't use these keys, use RunMode.DataSource instead)
  StimulusFile:
Changed:
<
<
defines Logic stimulus presentation file
StimulusFile = '/Volumes/bci_stims/my_experiment/logic/myblock.lso'

>
>
defines Logic stimulus presentation file
StimulusFile = '/Volumes/bci_stims/my_experiment/logic/myblock.lso'

  ActiviewConfigFile:
Changed:
<
<
defines settings for Actiview to control BioSemi's Active2 acquisition, i.e., number of acquired channels, sample rate etc.
ActiviewConfigFile = 'Actiview_MMMdefault.cfg' % (default)
ActiviewConfigFile = 'Actiview_MMMdefault_cap64.cfg'
ActiviewConfigFile = 'Actiview_MMMaib_cap64.cfg'
ActiviewConfigFile = 'Actiview_MMMaib.cfg'
>
>
defines settings for Actiview to control BioSemi's Active2 acquisition, i.e., number of acquired channels, sample rate etc.
ActiviewConfigFile = 'Actiview_MMMdefault.cfg' % (default)
ActiviewConfigFile = 'Actiview_MMMdefault_cap64.cfg'
ActiviewConfigFile = 'Actiview_MMMaib_cap64.cfg'
ActiviewConfigFile = 'Actiview_MMMaib.cfg'
  [BiosemiAcq]
Changed:
<
<
>
>
  Host:
Changed:
<
<
ip number of host running Actiview
Host = '123.456.789.100' % (or 'localhost', or 'server.dcc.ru.nl')
>
>
ip number of host running Actiview
Host = '123.456.789.100' % (or 'localhost', or 'server.dcc.ru.nl')
  Port:
Changed:
<
<
port to connect to on host running Actiview
Port = 5050
>
>
port to connect to on host running Actiview
Port = 5050
  [Experiment]
Changed:
<
<
>
>
  *Block:
Deleted:
<
<
name descriptive for the sub-experiment to run
Block = 'speller'
specify function to call by BrainStream for setting Matlab path
MatlabPathFnc? = 'setREPOSpath(get_app_folders({''p300_prn_impl2''}))'
specify list of extra folders to add to Matlab path
MatlabPathAdd = {'/Volumes/code/my_experiments/', fullfile(get_repos_root,'/own_experiments/visual/')}
 \ No newline at end of file
Added:
>
>
name descriptive for the sub-experiment to run
Block = 'speller'

MatlabPathFnc:

specify function to call by BrainStream for setting Matlab path

MatlabPathFnc = 'setREPOSpath('get_app_folders({''myexperiment''}))'

MatlabPathAdd:
specify list of extra folders to add to Matlab path
MatlabPathAdd = {'/Volumes/code/my_experiments/',fullfile(get_repos_root,'/own_experiments/visual/')}

[Clients]

<name of client>: client name descriptive for the actions that execute parallel-wise

client1 = '131.174.123.456'
client2 = 'eegstim.mydomain.nl'
client3 = 'core1' % dedicate/reserve specific core
client4 = 'cores' % BrainStream picks first available core
client5 = 'local' % execute serial-wise (overruled; no parallel execution)

Revision 610 Aug 2009 - Main.PhilipVanDenBroek

Line: 1 to 1
 
META TOPICPARENT name="DocsSectionsGettingStarted"
The block file is the starting point for BrainStream, from this file it reads all information required to initiate the experiment block in the platform. The format of the file is according to the windows ini-file style with topics enclosed in brackets and subsequent lines to define keys that belong to this topic. If another bracketed line is encountered, a new topic is started and additional lines will add keys to this new topic. Two topics are always required: RunMode with key DataSource, and Files with keys, ExperimentDefinitionFile and OutFolder. Users can add as many topics with corresponding keys as they like as long as they don't use any of the topics used by BrainStream.

A complete overview of topics and keys and their meaning (keys starting with an asterisk are obligate):

[RunMode]

Changed:
<
<
>
>
  *DataSource:
Changed:
<
<
defines what source is responsible for supplying the raw data to BrainStream.
DataSource = 'BioSemiAcq' % BioSemi's Active2.
DataSource = '/my_data/filename.ext' % specify any file supported by fieldtrip/FileIO (also fcdc_buffer).
DataSource = 'NoAcqSource' %(or []) simulates no data source, requested data will al be filled with zeros (NB: RunMode.RealTime will be forced to true).

>
>
defines what source is responsible for supplying the raw data to BrainStream.
DataSource = 'BioSemiAcq' % BioSemi's Active2.
DataSource = '/my_data/filename.ext' % specify any file supported by fieldtrip/FileIO (also fcdc_buffer).
DataSource = 'NoAcqSource' %(or []) simulates no data source, requested data will al be filled with zeros (NB: RunMode.RealTime will be forced to true).

  *Subject: (automatically included if starting using the GUI)
Changed:
<
<
at the end, just before BrainStream stops executing your block, BrainStream copies the final state to the OutFolder. The state contains all information BrainStream requires for its internal processing. This Subject's name is incorporated in the name of the corresponding mat-file.
Subject = 'a_subjects_name'

>
>
at the end, just before BrainStream stops executing your block, BrainStream copies the final state to the OutFolder. The state contains all information BrainStream requires for its internal processing. This Subject's name is incorporated in the name of the corresponding mat-file.
Subject = 'a_subjects_name'

  SampleRateAfterDecimation:
Changed:
<
<
if incoming raw data needs to be downsampled in time, set this key to the desired value. The ratio between the acquisition sample rate and SampleRateAfterDecimation must be a power of 2 and >= 1, i.e., 1,2,4,8 or 16. BrainStream applies a low-pass filter to the raw data before downsampling and for the filtering step it collects additional samples in order to provide the requested data epoch to the user (without filter edge effects). Be aware of the fact that it introduces a slightly delay in the moment data becomes available to the user.
SampleRateAfterDecimation = 256 % acquisition sample rate then should be 256Hz or 512, or 1024, or 2048 etc.

>
>
if incoming raw data needs to be downsampled in time, set this key to the desired value. The ratio between the acquisition sample rate and SampleRateAfterDecimation must be a power of 2 and >= 1, i.e., 1,2,4,8 or 16. BrainStream applies a low-pass filter to the raw data before downsampling and for the filtering step it collects additional samples in order to provide the requested data epoch to the user (without filter edge effects). Be aware of the fact that it introduces a slightly delay in the moment data becomes available to the user.
SampleRateAfterDecimation = 256 % acquisition sample rate then should be 256Hz or 512, or 1024, or 2048 etc.

  screenoutputlevel:
Changed:
<
<
sets the amount of information that is displayed during processing.
screenoutputlevel = 'ERROR' % (default) only displays errors and approximately every 10 seconds it indicates progress made.
screenoutputlevel = 'INFO' % also displays which markers' actions are currently being processed in Matlab command window.
screenoutputlevel = 'WARNING' % also displays warning messages.
screenoutputlevel = 'DEBUG' % also displays extra information about processed actions (use only in case debugging is required).

>
>
sets the amount of information that is displayed during processing.
screenoutputlevel = 'ERROR' % (default) only displays errors and approximately every 10 seconds it indicates progress made.
screenoutputlevel = 'INFO' % also displays which markers' actions are currently being processed in Matlab command window.
screenoutputlevel = 'WARNING' % also displays warning messages.
screenoutputlevel = 'DEBUG' % also displays extra information about processed actions (use only in case debugging is required).

  TriggerSource:
Changed:
<
<
only used in case data source is FileIO via fcdc_buffer via BCI2000. This way it is possible to manage incoming markers directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event.
NB, last channel is assumed to be the trigger channel!!!!
TriggerSource = 'trigger' % (default = 'default')

>
>
only used in case data source is FileIO via fcdc_buffer via BCI2000. This way it is possible to manage incoming markers directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event.
NB, last channel is assumed to be the trigger channel!!!!
TriggerSource = 'trigger' % (default = 'default')

  TriggerDef:
Changed:
<
<
defines how trigger channel information should be translated into marker information.
TriggerDef = 'trigger_definitions.txt'

>
>
defines how trigger channel information should be translated into marker information.
TriggerDef = 'trigger_definitions.txt'

  DataFormat:
Changed:
<
<
only used in case data source is FileIO via fcdc_buffer via BCI2000. This way it is possible to manage incoming markers directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event. Since the actual data acquisition source can be any BCI2000 supported device, DataFormat should be defined so that BrainStream knows how to handle incoming trigger data.
DataFormat = 'biosemi_bdf' % currently the only supported one using BCI2000 via FileIO. (warning, still needs to solve trigger channel filtering issue)

>
>
only used in case data source is FileIO via fcdc_buffer via BCI2000. This way it is possible to manage incoming markers directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event. Since the actual data acquisition source can be any BCI2000 supported device, DataFormat should be defined so that BrainStream knows how to handle incoming trigger data.
DataFormat = 'biosemi_bdf' % currently the only supported one using BCI2000 via FileIO. (warning, still needs to solve trigger channel filtering issue)

  RealTime:
Changed:
<
<
use only in case running with an offline data source, i.e., from file or no data at all (DataSource='NoAcqSource'). Set this value to true in order to simulate real-time data processing. Set it to false if offline data processing should be done as quickly as possible.
RealTime = true % (or 1)

>
>
use only in case running with an offline data source, i.e., from file or no data at all (DataSource='NoAcqSource'). Set this value to true in order to simulate real-time data processing. Set it to false if offline data processing should be done as quickly as possible.
RealTime = true % (or 1)

  Parallel:
Changed:
<
<
set to true to enable parallel processing of markers' actions. In the experiment definition table it needs to be specified which markers actions are allowed to be processed in parallel. See .... for more details.
Parallel = true % (or 1, default = false)

>
>
set to true to enable parallel processing of markers' actions. In the experiment definition table it needs to be specified which markers actions are allowed to be processed in parallel. See .... for more details.
Parallel = true % (or 1, default = false)

  NumCores:
Changed:
<
<
in case BrainStreams parallel running mode is set to true, this key specifies the number of cores BrainStream should utilize for its parallel processing. Every additional core will then run a separate Matlab session. The Matlab session running BrainStream itself will dedicate jobs to these extra `matlab sessions dependent of how users have configured their experiment definition tables. See .... for more details.
Numcores = 4

>
>
in case BrainStreams parallel running mode is set to true, this key specifies the number of cores BrainStream should utilize for its parallel processing. Every additional core will then run a separate Matlab session. The Matlab session running BrainStream itself will dedicate jobs to these extra `matlab sessions dependent of how users have configured their experiment definition tables. See .... for more details.
Numcores = 4

  StimulusPresentationSource:
Changed:
<
<
defines stimulus presentation source.
StimulusPresentationSource = 'Logic' % (default)
StimuluspresentationSource = 'PsychToolBox'

>
>
defines stimulus presentation source.
StimulusPresentationSource = 'Logic' % (default)
StimuluspresentationSource = 'PsychToolBox'

  RecordStartIndex:
Changed:
<
<
defines from which record to start reading the file (only DataSource=BDFFile)
RecordStartIndex = 1 % (default) only used in case data source is a biosemi .bdf file
>
>
defines from which record to start reading the file (only DataSource=BDFFile)
RecordStartIndex = 1 % (default) only used in case data source is a biosemi .bdf file
  Cap:
Changed:
<
<
defines which cap will be used at startup. User functions are responsible for changing hdr and current cap information after changing the cap (after spatial downsampling for example)
Cap = 'biosemi_cap256'
Cap = 'biosemi_cap64'

>
>
defines which cap will be used at startup. User functions are responsible for changing hdr and current cap information after changing the cap (after spatial downsampling for example)
Cap = 'biosemi_cap256'
Cap = 'biosemi_cap64'

  CopyStimFiles:
Changed:
<
<
Set to true (default) if stimulus files need to be copied from bci_stims volume to the local stimulus presentation computer.
CopyStimFiles = 1

>
>
Set to true (default) if stimulus files need to be copied from bci_stims volume to the local stimulus presentation computer.
CopyStimFiles = 1

  LoadStimulusFile:
Changed:
<
<
set to true (default) to start Logic and load stimulus presentation file.
=LoadStimulusFile = 1

>
>
set to true (default) to start Logic and load stimulus presentation file.
=LoadStimulusFile = 1
  [Files]
Changed:
<
<
>
>
  *ReferenceFolder: (automatically included if starting using the GUI)
Changed:
<
<
defines the folder where the experiment definition file is located. Inside the tables relative path names are translated to absolute path names relative to this ReferenceFolder. This key must be defined.
ReferenceFolder = '/Volumes/bci_stims/my_experiment/'

>
>
defines the folder where the experiment definition file is located. Inside the tables relative path names are translated to absolute path names relative to this ReferenceFolder. This key must be defined.
ReferenceFolder = '/Volumes/bci_stims/my_experiment/'

  *OutFolder:
Changed:
<
<
defines path to location where BrainStream can store output. This key must be defined.
OutFolder = '/Volumes/bci_data/my_experiment/'

>
>
defines path to location where BrainStream can store output. This key must be defined.
OutFolder = '/Volumes/bci_data/my_experiment/'

  *ExperimentDefinitionFile:
Changed:
<
<
the file that defines the experiment to run.
ExperimentDefinitionFile = '/Volumes/bci_stims/my_experiment/myblock.xls'

>
>
the file that defines the experiment to run.
ExperimentDefinitionFile = '/Volumes/bci_stims/my_experiment/myblock.xls'

  ExperimentDefinitionData:
Changed:
<
<
defines in which table or sheet BrainStream can find information about which markers request data for their actions.
ExperimentDefinitionData = 'DataSelection' % (=default)

>
>
defines in which table or sheet BrainStream can find information about which markers request data for their actions.
ExperimentDefinitionData = 'DataSelection' % (=default)

  ExperimentDefinitionSubFile:
Changed:
<
<
defines from which table or sheet BrainStream should start reading markers' actions.
ExperimentDefinitionSubFile = 'Actions' % (=default)

DataFile (deprecated!, don't use these keys, use RunMode.DataSource instead)
DataFileDir (deprecated!, don't use these keys, use RunMode.DataSource instead)
>
>
defines from which table or sheet BrainStream should start reading markers' actions.
ExperimentDefinitionSubFile = 'Actions' % (=default)

DataFile (deprecated!, don't use these keys, use RunMode.DataSource instead)
DataFileDir (deprecated!, don't use these keys, use RunMode.DataSource instead)
  StimulusFile:
Changed:
<
<
defines Logic stimulus presentation file
StimulusFile = '/Volumes/bci_stims/my_experiment/logic/myblock.lso'

>
>
defines Logic stimulus presentation file
StimulusFile = '/Volumes/bci_stims/my_experiment/logic/myblock.lso'

  ActiviewConfigFile:
Changed:
<
<
defines settings for Actiview to control BioSemi's Active2 acquisition, i.e., number of acquired channels, sample rate etc.
ActiviewConfigFile = 'Actiview_MMMdefault.cfg' % (default)
ActiviewConfigFile = 'Actiview_MMMdefault_cap64.cfg'
ActiviewConfigFile = 'Actiview_MMMaib_cap64.cfg'
ActiviewConfigFile = 'Actiview_MMMaib.cfg'

>
>
defines settings for Actiview to control BioSemi's Active2 acquisition, i.e., number of acquired channels, sample rate etc.
ActiviewConfigFile = 'Actiview_MMMdefault.cfg' % (default)
ActiviewConfigFile = 'Actiview_MMMdefault_cap64.cfg'
ActiviewConfigFile = 'Actiview_MMMaib_cap64.cfg'
ActiviewConfigFile = 'Actiview_MMMaib.cfg'
  [BiosemiAcq]
Changed:
<
<
>
>
  Host:
Changed:
<
<
ip number of host running Actiview
Host = '123.456.789.100' % (or 'localhost', or 'server.dcc.ru.nl')
>
>
ip number of host running Actiview
Host = '123.456.789.100' % (or 'localhost', or 'server.dcc.ru.nl')
  Port:
Changed:
<
<
port to connect to on host running Actiview
Port = 5050

>
>
port to connect to on host running Actiview
Port = 5050
  [Experiment]
Changed:
<
<
>
>
  *Block:
Deleted:
<
<
name descriptive for the sub-experiment to run
Block = 'speller'

 \ No newline at end of file
Added:
>
>
name descriptive for the sub-experiment to run
Block = 'speller'
specify function to call by BrainStream for setting Matlab path
MatlabPathFnc? = 'setREPOSpath(get_app_folders({''p300_prn_impl2''}))'
specify list of extra folders to add to Matlab path
MatlabPathAdd = {'/Volumes/code/my_experiments/', fullfile(get_repos_root,'/own_experiments/visual/')}
 \ No newline at end of file

Revision 520 Jun 2009 - Main.PhilipVanDenBroek

Line: 1 to 1
 
META TOPICPARENT name="DocsSectionsGettingStarted"
Changed:
<
<
The block file is the starting point for BrainStream, from this file it reads all information required to initiate the experiment block in the platform. The format of the file is according to the windows ini-file style with topics enclosed in brackets and subsequent lines to define keys that belong to this topic. If another bracketed line is encountered, a new topic is started and additional lines will add keys to this new topic. Two topics are always required: RunMode with key DataSource, and Files with keys, ExperimentDefinitionFile and OutFolder. Users can add as many topics with corresponding keys as they like as long as they don't use any of the topics used by BrainStream.

A complete overview of topics and keys and their meaning (keys starting with an asterisk are obligate):

>
>
The block file is the starting point for BrainStream, from this file it reads all information required to initiate the experiment block in the platform. The format of the file is according to the windows ini-file style with topics enclosed in brackets and subsequent lines to define keys that belong to this topic. If another bracketed line is encountered, a new topic is started and additional lines will add keys to this new topic. Two topics are always required: RunMode with key DataSource, and Files with keys, ExperimentDefinitionFile and OutFolder. Users can add as many topics with corresponding keys as they like as long as they don't use any of the topics used by BrainStream.

A complete overview of topics and keys and their meaning (keys starting with an asterisk are obligate):
 
Changed:
<
<
[RunMode]
>
>
[RunMode]
  *DataSource:
Changed:
<
<
defines what source is responsible for supplying the raw data to BrainStream.
DataSource = 'BioSemiAcq' % BioSemi's Active2.
DataSource = 'BDFFile' % from file, biosemi dataformat (.bdf).
DataSource = 'FileIO' % any file format supported by fieldtrip/FileIO (also fcdc_buffer).
DataSource = 'NoAcqSource' % simulates no data source, requested data will al be filled with zeros (NB: RunMode.RealTime will be forced to true).

>
>
defines what source is responsible for supplying the raw data to BrainStream.
DataSource = 'BioSemiAcq' % BioSemi's Active2.
DataSource = '/my_data/filename.ext' % specify any file supported by fieldtrip/FileIO (also fcdc_buffer).
DataSource = 'NoAcqSource' %(or []) simulates no data source, requested data will al be filled with zeros (NB: RunMode.RealTime will be forced to true).

  *Subject: (automatically included if starting using the GUI)
Changed:
<
<
at the end, just before BrainStream stops executing your block, BrainStream copies the final state to the OutFolder. The state contains all information BrainStream requires for its internal processing. This Subject's name is incorporated in the name of the corresponding mat-file.
Subject = 'a_subjects_name'

>
>
at the end, just before BrainStream stops executing your block, BrainStream copies the final state to the OutFolder. The state contains all information BrainStream requires for its internal processing. This Subject's name is incorporated in the name of the corresponding mat-file.
Subject = 'a_subjects_name'

  SampleRateAfterDecimation:
Changed:
<
<
if incoming raw data needs to be downsampled in time, set this key to the desired value. The ratio between the acquisition sample rate and SampleRateAfterDecimation must be a power of 2 and >= 1, i.e., 1,2,4,8 or 16. BrainStream applies a low-pass filter to the raw data before downsampling and for the filtering step it collects additional samples in order to provide the requested data epoch to the user (without filter edge effects). Be aware of the fact that it introduces a slightly delay in the moment data becomes available to the user.
SampleRateAfterDecimation = 256 % acquisition sample rate then should be 256Hz or 512, or 1024, or 2048 etc.

>
>
if incoming raw data needs to be downsampled in time, set this key to the desired value. The ratio between the acquisition sample rate and SampleRateAfterDecimation must be a power of 2 and >= 1, i.e., 1,2,4,8 or 16. BrainStream applies a low-pass filter to the raw data before downsampling and for the filtering step it collects additional samples in order to provide the requested data epoch to the user (without filter edge effects). Be aware of the fact that it introduces a slightly delay in the moment data becomes available to the user.
SampleRateAfterDecimation = 256 % acquisition sample rate then should be 256Hz or 512, or 1024, or 2048 etc.

  screenoutputlevel:
Changed:
<
<
sets the amount of information that is displayed during processing.
screenoutputlevel = 'ERROR' % (default) only displays errors and approximately every 10 seconds it indicates progress made.
screenoutputlevel = 'INFO' % also displays which markers' actions are currently being processed in Matlab command window.
screenoutputlevel = 'WARNING' % also displays warning messages.
screenoutputlevel = 'DEBUG' % also displays extra information about processed actions (use only in case debugging is required).

>
>
sets the amount of information that is displayed during processing.
screenoutputlevel = 'ERROR' % (default) only displays errors and approximately every 10 seconds it indicates progress made.
screenoutputlevel = 'INFO' % also displays which markers' actions are currently being processed in Matlab command window.
screenoutputlevel = 'WARNING' % also displays warning messages.
screenoutputlevel = 'DEBUG' % also displays extra information about processed actions (use only in case debugging is required).

  TriggerSource:
Changed:
<
<
only used in case data source is FileIO via fcdc_buffer via BCI2000. This way it is possible to manage incoming markers directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event.
NB, last channel is assumed to be the trigger channel!!!!
TriggerSource = 'trigger' % (default = 'default')

>
>
only used in case data source is FileIO via fcdc_buffer via BCI2000. This way it is possible to manage incoming markers directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event.
NB, last channel is assumed to be the trigger channel!!!!
TriggerSource = 'trigger' % (default = 'default')

  TriggerDef:
Changed:
<
<
defines how trigger channel information should be translated into marker information.
TriggerDef = 'trigger_definitions.txt'

>
>
defines how trigger channel information should be translated into marker information.
TriggerDef = 'trigger_definitions.txt'

  DataFormat:
Changed:
<
<
only used in case data source is FileIO via fcdc_buffer via BCI2000. This way it is possible to manage incoming markers directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event. Since the actual data acquisition source can be any BCI2000 supported device, DataFormat should be defined so that BrainStream knows how to handle incoming trigger data.
DataFormat = 'biosemi_bdf' % currently the only supported one using BCI2000 via FileIO. (warning, still needs to solve trigger channel filtering issue)

>
>
only used in case data source is FileIO via fcdc_buffer via BCI2000. This way it is possible to manage incoming markers directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event. Since the actual data acquisition source can be any BCI2000 supported device, DataFormat should be defined so that BrainStream knows how to handle incoming trigger data.
DataFormat = 'biosemi_bdf' % currently the only supported one using BCI2000 via FileIO. (warning, still needs to solve trigger channel filtering issue)

  RealTime:
Changed:
<
<
use only in case running with an offline data source, i.e., from file or no data at all (DataSource='NoAcqSource'). Set this value to true in order to simulate real-time data processing. Set it to false if offline data processing should be done as quickly as possible.
RealTime = true % (or 1)

>
>
use only in case running with an offline data source, i.e., from file or no data at all (DataSource='NoAcqSource'). Set this value to true in order to simulate real-time data processing. Set it to false if offline data processing should be done as quickly as possible.
RealTime = true % (or 1)

  Parallel:
Changed:
<
<
set to true to enable parallel processing of markers' actions. In the experiment definition table it needs to be specified which markers actions are allowed to be processed in parallel. See .... for more details.
Parallel = true % (or 1, default = false)

>
>
set to true to enable parallel processing of markers' actions. In the experiment definition table it needs to be specified which markers actions are allowed to be processed in parallel. See .... for more details.
Parallel = true % (or 1, default = false)

  NumCores:
Changed:
<
<
in case BrainStreams parallel running mode is set to true, this key specifies the number of cores BrainStream should utilize for its parallel processing. Every additional core will then run a separate Matlab session. The Matlab session running BrainStream itself will dedicate jobs to these extra `matlab sessions dependent of how users have configured their experiment definition tables. See .... for more details.
Numcores = 4

>
>
in case BrainStreams parallel running mode is set to true, this key specifies the number of cores BrainStream should utilize for its parallel processing. Every additional core will then run a separate Matlab session. The Matlab session running BrainStream itself will dedicate jobs to these extra `matlab sessions dependent of how users have configured their experiment definition tables. See .... for more details.
Numcores = 4

  StimulusPresentationSource:
Changed:
<
<
defines stimulus presentation source.
StimulusPresentationSource = 'Logic' % (default)
StimuluspresentationSource = 'PsychToolBox'

>
>
defines stimulus presentation source.
StimulusPresentationSource = 'Logic' % (default)
StimuluspresentationSource = 'PsychToolBox'

  RecordStartIndex:
Changed:
<
<
defines from which record to start reading the file (only DataSource=BDFFile)
RecordStartIndex = 1 % (default) only used in case data source is a biosemi .bdf file
>
>
defines from which record to start reading the file (only DataSource=BDFFile)
RecordStartIndex = 1 % (default) only used in case data source is a biosemi .bdf file
  Cap:
Changed:
<
<
defines which cap will be used at startup. User functions are responsible for changing hdr and current cap information after changing the cap (after spatial downsampling for example)
Cap = 'biosemi_cap256'
Cap = 'biosemi_cap64'

>
>
defines which cap will be used at startup. User functions are responsible for changing hdr and current cap information after changing the cap (after spatial downsampling for example)
Cap = 'biosemi_cap256'
Cap = 'biosemi_cap64'

  CopyStimFiles:
Changed:
<
<
Set to true (default) if stimulus files need to be copied from bci_stims volume to the local stimulus presentation computer.
CopyStimFiles = 1

>
>
Set to true (default) if stimulus files need to be copied from bci_stims volume to the local stimulus presentation computer.
CopyStimFiles = 1

  LoadStimulusFile:
Changed:
<
<
set to true (default) to start Logic and load stimulus presentation file.
=LoadStimulusFile = 1


>
>
set to true (default) to start Logic and load stimulus presentation file.
=LoadStimulusFile = 1

 
Changed:
<
<
[Files]
>
>
[Files]
  *ReferenceFolder: (automatically included if starting using the GUI)
Changed:
<
<
defines the folder where the experiment definition file is located. Inside the tables relative path names are translated to absolute path names relative to this ReferenceFolder. This key must be defined.
ReferenceFolder = '/Volumes/bci_stims/my_experiment/'

>
>
defines the folder where the experiment definition file is located. Inside the tables relative path names are translated to absolute path names relative to this ReferenceFolder. This key must be defined.
ReferenceFolder = '/Volumes/bci_stims/my_experiment/'

  *OutFolder:
Changed:
<
<
defines path to location where BrainStream can store output. This key must be defined.
OutFolder = '/Volumes/bci_data/my_experiment/'

>
>
defines path to location where BrainStream can store output. This key must be defined.
OutFolder = '/Volumes/bci_data/my_experiment/'

  *ExperimentDefinitionFile:
Changed:
<
<
the file that defines the experiment to run.
ExperimentDefinitionFile = '/Volumes/bci_stims/my_experiment/myblock.xls'

>
>
the file that defines the experiment to run.
ExperimentDefinitionFile = '/Volumes/bci_stims/my_experiment/myblock.xls'

  ExperimentDefinitionData:
Changed:
<
<
defines in which table or sheet BrainStream can find information about which markers request data for their actions.
ExperimentDefinitionData = 'DataSelection' % (=default)

>
>
defines in which table or sheet BrainStream can find information about which markers request data for their actions.
ExperimentDefinitionData = 'DataSelection' % (=default)

  ExperimentDefinitionSubFile:
Changed:
<
<
defines from which table or sheet BrainStream should start reading markers' actions.
ExperimentDefinitionSubFile = 'Actions' % (=default)

DataFile (deprecated!, don't use these keys, use RunMode.DataSource instead)
DataFileDir (deprecated!, don't use these keys, use RunMode.DataSource instead)

>
>
defines from which table or sheet BrainStream should start reading markers' actions.
ExperimentDefinitionSubFile = 'Actions' % (=default)

DataFile (deprecated!, don't use these keys, use RunMode.DataSource instead)
DataFileDir (deprecated!, don't use these keys, use RunMode.DataSource instead)
  StimulusFile:
Changed:
<
<
defines Logic stimulus presentation file
StimulusFile = '/Volumes/bci_stims/my_experiment/logic/myblock.lso'

>
>
defines Logic stimulus presentation file
StimulusFile = '/Volumes/bci_stims/my_experiment/logic/myblock.lso'

  ActiviewConfigFile:
Changed:
<
<
defines settings for Actiview to control BioSemi's Active2 acquisition, i.e., number of acquired channels, sample rate etc.
ActiviewConfigFile = 'Actiview_MMMdefault.cfg' % (default)
ActiviewConfigFile = 'Actiview_MMMdefault_cap64.cfg'
ActiviewConfigFile = 'Actiview_MMMaib_cap64.cfg'
ActiviewConfigFile = 'Actiview_MMMaib.cfg'


>
>
defines settings for Actiview to control BioSemi's Active2 acquisition, i.e., number of acquired channels, sample rate etc.
ActiviewConfigFile = 'Actiview_MMMdefault.cfg' % (default)
ActiviewConfigFile = 'Actiview_MMMdefault_cap64.cfg'
ActiviewConfigFile = 'Actiview_MMMaib_cap64.cfg'
ActiviewConfigFile = 'Actiview_MMMaib.cfg'

 
Changed:
<
<
[BiosemiAcq]
>
>
[BiosemiAcq]
  Host:
Changed:
<
<
ip number of host running Actiview
Host = '123.456.789.100' % (or 'localhost', or 'server.dcc.ru.nl')

>
>
ip number of host running Actiview
Host = '123.456.789.100' % (or 'localhost', or 'server.dcc.ru.nl')
  Port:
Changed:
<
<
port to connect to on host running Actiview
Port = 5050


>
>
port to connect to on host running Actiview
Port = 5050

 
Changed:
<
<
[Experiment]
>
>
[Experiment]
  *Block:
Changed:
<
<
name descriptive for the sub-experiment to run
Block = 'speller'


>
>
name descriptive for the sub-experiment to run
Block = 'speller'

 \ No newline at end of file

Revision 407 May 2009 - Main.PhilipVanDenBroek

Line: 1 to 1
 
META TOPICPARENT name="DocsSectionsGettingStarted"
Added:
>
>
The block file is the starting point for BrainStream, from this file it reads all information required to initiate the experiment block in the platform. The format of the file is according to the windows ini-file style with topics enclosed in brackets and subsequent lines to define keys that belong to this topic. If another bracketed line is encountered, a new topic is started and additional lines will add keys to this new topic. Two topics are always required: RunMode with key DataSource, and Files with keys, ExperimentDefinitionFile and OutFolder. Users can add as many topics with corresponding keys as they like as long as they don't use any of the topics used by BrainStream.

A complete overview of topics and keys and their meaning (keys starting with an asterisk are obligate):

 [RunMode]
Changed:
<
<
DataSource:
>
>
*DataSource:
 
defines what source is responsible for supplying the raw data to BrainStream.
DataSource = 'BioSemiAcq' % BioSemi's Active2.
Line: 11 to 19
 DataSource = 'NoAcqSource' % simulates no data source, requested data will al be filled with zeros (NB: RunMode.RealTime will be forced to true).

Changed:
<
<
Subject:
>
>
*Subject: (automatically included if starting using the GUI)
 
at the end, just before BrainStream stops executing your block, BrainStream copies the final state to the OutFolder. The state contains all information BrainStream requires for its internal processing. This Subject's name is incorporated in the name of the corresponding mat-file.
Subject = 'a_subjects_name'
Line: 36 to 48
 
only used in case data source is FileIO via fcdc_buffer via BCI2000. This way it is possible to manage incoming markers directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event.
NB, last channel is assumed to be the trigger channel!!!!
Changed:
<
<
TriggerSource = 'trigger' (default = 'default')
>
>
TriggerSource = 'trigger' % (default = 'default')
 
Added:
>
>
 TriggerDef:
defines how trigger channel information should be translated into marker information.
Line: 54 to 69
 RealTime:
use only in case running with an offline data source, i.e., from file or no data at all (DataSource='NoAcqSource'). Set this value to true in order to simulate real-time data processing. Set it to false if offline data processing should be done as quickly as possible.
Changed:
<
<
RealTime = true (or 1)
>
>
RealTime = true % (or 1)
 
Added:
>
>
 Parallel:
set to true to enable parallel processing of markers' actions. In the experiment definition table it needs to be specified which markers actions are allowed to be processed in parallel. See .... for more details.
Line: 60 to 76
 Parallel:
set to true to enable parallel processing of markers' actions. In the experiment definition table it needs to be specified which markers actions are allowed to be processed in parallel. See .... for more details.
Changed:
<
<
Parallel = true (or 1, default = false)
>
>
Parallel = true % (or 1, default = false)
 
Added:
>
>
 NumCores:
in case BrainStreams parallel running mode is set to true, this key specifies the number of cores BrainStream should utilize for its parallel processing. Every additional core will then run a separate Matlab session. The Matlab session running BrainStream itself will dedicate jobs to these extra `matlab sessions dependent of how users have configured their experiment definition tables. See .... for more details.
Line: 72 to 90
 StimulusPresentationSource:
defines stimulus presentation source.
Changed:
<
<
StimulusPresentationSource = 'Logic' (default)
>
>
StimulusPresentationSource = 'Logic' % (default)
 StimuluspresentationSource = 'PsychToolBox'

Line: 79 to 98
 RecordStartIndex:
defines from which record to start reading the file (only DataSource=BDFFile)
Changed:
<
<
RecordStartIndex = 1 (default) only used in case data source is a biosemi .bdf file
>
>
RecordStartIndex = 1 % (default) only used in case data source is a biosemi .bdf file
 
Added:
>
>
 Cap:
defines which cap will be used at startup. User functions are responsible for changing hdr and current cap information after changing the cap (after spatial downsampling for example)
Line: 92 to 113
 CopyStimFiles:
Set to true (default) if stimulus files need to be copied from bci_stims volume to the local stimulus presentation computer.
Changed:
<
<
=CopyStimFiles = 1
>
>
CopyStimFiles = 1
 
Added:
>
>
 LoadStimulusFile:
set to true (default) to start Logic and load stimulus presentation file.
Line: 98 to 120
 LoadStimulusFile:
set to true (default) to start Logic and load stimulus presentation file.
Changed:
<
<
LoadStimulusFile? = 1
>
>
=LoadStimulusFile = 1
 
Line: 106 to 128
  [Files]
Changed:
<
<
ReferenceFolder:
>
>
*ReferenceFolder: (automatically included if starting using the GUI)
 
defines the folder where the experiment definition file is located. Inside the tables relative path names are translated to absolute path names relative to this ReferenceFolder. This key must be defined.
ReferenceFolder = '/Volumes/bci_stims/my_experiment/'

Changed:
<
<
OutFolder:
>
>
*OutFolder:
 
defines path to location where BrainStream can store output. This key must be defined.
OutFolder = '/Volumes/bci_data/my_experiment/'

Changed:
<
<
ExperimentDefinitionFile:
>
>
*ExperimentDefinitionFile:
 
the file that defines the experiment to run.
ExperimentDefinitionFile = '/Volumes/bci_stims/my_experiment/myblock.xls'
Line: 127 to 153
 ExperimentDefinitionData:
defines in which table or sheet BrainStream can find information about which markers request data for their actions.
Changed:
<
<
ExperimentDefinitionData = 'DataSelection' (=default)
>
>
ExperimentDefinitionData = 'DataSelection' % (=default)
 
Added:
>
>
 ExperimentDefinitionSubFile:
defines from which table or sheet BrainStream should start reading markers' actions.
Line: 133 to 160
 ExperimentDefinitionSubFile:
defines from which table or sheet BrainStream should start reading markers' actions.
Changed:
<
<
ExperimentDefinitionSubFile = 'Actions' (=default)
>
>
ExperimentDefinitionSubFile = 'Actions' % (=default)
 
Changed:
<
<
DataFile (deprecated!, don't use these keys)
DataFileDir (deprecated!, don't use these keys)
>
>
DataFile (deprecated!, don't use these keys, use RunMode.DataSource instead)
DataFileDir (deprecated!, don't use these keys, use RunMode.DataSource instead)
 
Added:
>
>
 StimulusFile:
defines Logic stimulus presentation file
Line: 148 to 177
 ActiviewConfigFile:
defines settings for Actiview to control BioSemi's Active2 acquisition, i.e., number of acquired channels, sample rate etc.
Changed:
<
<
ActiviewConfigFile = 'Actiview_MMMdefault.cfg' (default)
>
>
ActiviewConfigFile = 'Actiview_MMMdefault.cfg' % (default)
 ActiviewConfigFile = 'Actiview_MMMdefault_cap64.cfg'
ActiviewConfigFile = 'Actiview_MMMaib_cap64.cfg'
ActiviewConfigFile = 'Actiview_MMMaib.cfg'
Line: 162 to 192
 Host:
ip number of host running Actiview
Changed:
<
<
Host = '123.456.789.100' (or 'localhost', or 'server.dcc.ru.nl')
>
>
Host = '123.456.789.100' % (or 'localhost', or 'server.dcc.ru.nl')
 
Added:
>
>
 Port:
port to connect to on host running Actiview
Line: 176 to 207
  [Experiment]
Changed:
<
<
Block:
>
>
*Block:
 
name descriptive for the sub-experiment to run
Block = 'speller'

Revision 306 May 2009 - Main.PhilipVanDenBroek

Line: 1 to 1
 
META TOPICPARENT name="DocsSectionsGettingStarted"
Changed:
<
<
[RunMode]
>
>
[RunMode]
 
Changed:
<
<
DataSource: defines what source is responsible for supplying the raw data to BrainStream.
DataSource = 'BioSemiAcq' % BioSemi? 's Active2.
>
>
DataSource:
defines what source is responsible for supplying the raw data to BrainStream.
DataSource = 'BioSemiAcq' % BioSemi's Active2.
 DataSource = 'BDFFile' % from file, biosemi dataformat (.bdf).
DataSource = 'FileIO' % any file format supported by fieldtrip/FileIO (also fcdc_buffer).
Changed:
<
<
DataSource = 'NoAcqSource' % simulates no data source, requested data will al be filled with zeros (NB: RealTime? will be forced to true).
>
>
DataSource = 'NoAcqSource' % simulates no data source, requested data will al be filled with zeros (NB: RunMode.RealTime will be forced to true).
 
Changed:
<
<
Subject: at the end, just before BrainStream stops executing your block, BrainStream copies the final state to the OutFolder? . The state contains all information BrainStream requires for its internal processing. This Subject's name is incorporated in the name of the corresponding mat-file.
>
>
Subject:
at the end, just before BrainStream stops executing your block, BrainStream copies the final state to the OutFolder. The state contains all information BrainStream requires for its internal processing. This Subject's name is incorporated in the name of the corresponding mat-file.
 Subject = 'a_subjects_name'

Changed:
<
<
SampleRateAfterDecimation: if incoming raw data needs to be downsampled in time, set this key to the desired value. The ratio between the acquisition sample rate and SampleRateAfterDecimation must be a power of 2 and >= 1, i.e., 1,2,4,8 or 16. BrainStream applies a low-pass filter to the raw data before downsampling and for the filtering step it collects additional samples in order to provide the requested data epoch to the user (without filter edge effects). Be aware of the fact that it introduces a slightly delay in the moment data becomes available to the user.
>
>
SampleRateAfterDecimation:
if incoming raw data needs to be downsampled in time, set this key to the desired value. The ratio between the acquisition sample rate and SampleRateAfterDecimation must be a power of 2 and >= 1, i.e., 1,2,4,8 or 16. BrainStream applies a low-pass filter to the raw data before downsampling and for the filtering step it collects additional samples in order to provide the requested data epoch to the user (without filter edge effects). Be aware of the fact that it introduces a slightly delay in the moment data becomes available to the user.
 SampleRateAfterDecimation = 256 % acquisition sample rate then should be 256Hz or 512, or 1024, or 2048 etc.

Changed:
<
<
screenoutputlevel: sets the amount of information that is displayed during processing.
>
>
screenoutputlevel:
sets the amount of information that is displayed during processing.
 screenoutputlevel = 'ERROR' % (default) only displays errors and approximately every 10 seconds it indicates progress made.
screenoutputlevel = 'INFO' % also displays which markers' actions are currently being processed in Matlab command window.
screenoutputlevel = 'WARNING' % also displays warning messages.
screenoutputlevel = 'DEBUG' % also displays extra information about processed actions (use only in case debugging is required).

Changed:
<
<
TriggerSource: only used in case data source is FileIO via fcdc_buffer via BCI2000. This way it is possible to manage incoming markers directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event.
>
>
TriggerSource:
only used in case data source is FileIO via fcdc_buffer via BCI2000. This way it is possible to manage incoming markers directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event.
 NB, last channel is assumed to be the trigger channel!!!!
TriggerSource = 'trigger' (default = 'default')

Changed:
<
<
TriggerDef: defines how trigger channel information should be translated into marker information.
>
>
TriggerDef:
defines how trigger channel information should be translated into marker information.
 TriggerDef = 'trigger_definitions.txt'

Changed:
<
<
DataFormat: only used in case data source is FileIO via fcdc_buffer via BCI2000. This way it is possible to manage incoming markers directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event. Since the actual data acquisition source can be any BCI2000 supported device, DataFormat? should be defined so that BrainStream knows how to handle incoming trigger data.
DataFormat = 'biosemi_bdf' % currently the only supported one using BCI2000 via FileIO? . (warning, still needs to solve trigger channel filtering issue)
>
>
DataFormat:
only used in case data source is FileIO via fcdc_buffer via BCI2000. This way it is possible to manage incoming markers directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event. Since the actual data acquisition source can be any BCI2000 supported device, DataFormat should be defined so that BrainStream knows how to handle incoming trigger data.
DataFormat = 'biosemi_bdf' % currently the only supported one using BCI2000 via FileIO. (warning, still needs to solve trigger channel filtering issue)
 
Changed:
<
<
RealTime: use only in case running with an offline data source, i.e., from file or no data at all (DataSource? ='NoAcqSource'). Set this value to true in order to simulate real-time data processing. Set it to false if offline data processing should be done as quickly as possible.
>
>
RealTime:
use only in case running with an offline data source, i.e., from file or no data at all (DataSource='NoAcqSource'). Set this value to true in order to simulate real-time data processing. Set it to false if offline data processing should be done as quickly as possible.
 RealTime = true (or 1)

Changed:
<
<
Parallel: set to true to enable parallel processing of markers' actions. In the experiment definition table it needs to be specified which markers actions are allowed to be processed in parallel. See .... for more details.
>
>
Parallel:
set to true to enable parallel processing of markers' actions. In the experiment definition table it needs to be specified which markers actions are allowed to be processed in parallel. See .... for more details.
 Parallel = true (or 1, default = false)

Changed:
<
<
NumCores: in case BrainStreams parallel running mode is set to true, this key specifies the number of cores BrainStream should utilize for its parallel processing. Every additional core will then run a separate Matlab session. The Matlab session running BrainStream itself will dedicate jobs to these extra `matlab sessions dependent of how users have configured their experiment definition tables. See .... for more details.
>
>
NumCores:
in case BrainStreams parallel running mode is set to true, this key specifies the number of cores BrainStream should utilize for its parallel processing. Every additional core will then run a separate Matlab session. The Matlab session running BrainStream itself will dedicate jobs to these extra `matlab sessions dependent of how users have configured their experiment definition tables. See .... for more details.
 Numcores = 4

Changed:
<
<
StimulusPresentationSource? : defines stimulus presentation source.
>
>
StimulusPresentationSource:
defines stimulus presentation source.
 StimulusPresentationSource = 'Logic' (default)
StimuluspresentationSource = 'PsychToolBox'

Changed:
<
<
RecordStartIndex: defines from which record to start reading the file (only DataSource=BDFFile)
>
>
RecordStartIndex:
defines from which record to start reading the file (only DataSource=BDFFile)
 RecordStartIndex = 1 (default) only used in case data source is a biosemi .bdf file
Changed:
<
<
Cap: defines which cap will be used at startup. User functions are responsible for changing hdr and current cap information after changing the cap (after spatial downsampling for example)
>
>
Cap:
defines which cap will be used at startup. User functions are responsible for changing hdr and current cap information after changing the cap (after spatial downsampling for example)
 Cap = 'biosemi_cap256'
Cap = 'biosemi_cap64'

Changed:
<
<
CopyStimFiles: Set to true (default) if stimulus files need to be copied from bci_stims volume to the local stimulus presentation computer.
>
>
CopyStimFiles:
Set to true (default) if stimulus files need to be copied from bci_stims volume to the local stimulus presentation computer.
 =CopyStimFiles = 1

Changed:
<
<
LoadStimulusFile: set to true (default) to start Logic and load stimulus presentation file.
>
>
LoadStimulusFile:
set to true (default) to start Logic and load stimulus presentation file.
 LoadStimulusFile? = 1
Added:
>
>
 

Changed:
<
<
[Files]
>
>
[Files]
ReferenceFolder:
 
Changed:
<
<
ReferenceFolder: defines the folder where the experiment definition file is located. Inside the tables relative path names are translated to absolute path names relative to this ReferenceFolder? . This key must be defined.
>
>
defines the folder where the experiment definition file is located. Inside the tables relative path names are translated to absolute path names relative to this ReferenceFolder. This key must be defined.
 ReferenceFolder = '/Volumes/bci_stims/my_experiment/'

Changed:
<
<
OutFolder: defines path to location where BrainStream can store output. This key must be defined.
>
>
OutFolder:
defines path to location where BrainStream can store output. This key must be defined.
 OutFolder = '/Volumes/bci_data/my_experiment/'

Changed:
<
<
ExperimentDefinitionFile: the file that defines the experiment to run.
>
>
ExperimentDefinitionFile:
the file that defines the experiment to run.
 ExperimentDefinitionFile = '/Volumes/bci_stims/my_experiment/myblock.xls'

Changed:
<
<
ExperimentDefinitionData: defines in which table or sheet BrainStream can find information about which markers request data for their actions.
>
>
ExperimentDefinitionData:
defines in which table or sheet BrainStream can find information about which markers request data for their actions.
 ExperimentDefinitionData = 'DataSelection' (=default)

Changed:
<
<
ExperimentDefinitionSubFile : defines from which table or sheet BrainStream should start reading markers' actions.
>
>
ExperimentDefinitionSubFile:
defines from which table or sheet BrainStream should start reading markers' actions.
 ExperimentDefinitionSubFile = 'Actions' (=default)

Added:
>
>
 DataFile (deprecated!, don't use these keys)
DataFileDir (deprecated!, don't use these keys)

Changed:
<
<
StimulusFile: defines Logic stimulus presentation file
>
>
StimulusFile:
defines Logic stimulus presentation file
 StimulusFile = '/Volumes/bci_stims/my_experiment/logic/myblock.lso'

Changed:
<
<
ActiviewConfigFile: defines settings for Actiview to control BioSemi's Active2 acquisition, i.e., number of acquired channels, sample rate etc.
>
>
ActiviewConfigFile:
defines settings for Actiview to control BioSemi's Active2 acquisition, i.e., number of acquired channels, sample rate etc.
 ActiviewConfigFile = 'Actiview_MMMdefault.cfg' (default)
ActiviewConfigFile = 'Actiview_MMMdefault_cap64.cfg'
ActiviewConfigFile = 'Actiview_MMMaib_cap64.cfg'
ActiviewConfigFile = 'Actiview_MMMaib.cfg'
Added:
>
>
 

Changed:
<
<
[BiosemiAcq]
>
>
[BiosemiAcq]
 
Changed:
<
<
Host: ip number of host running Actiview
>
>
Host:
ip number of host running Actiview
 Host = '123.456.789.100' (or 'localhost', or 'server.dcc.ru.nl')
Added:
>
>
 
Changed:
<
<
Port: port to connect to on host running Actiview
>
>
Port:
port to connect to on host running Actiview
 Port = 5050
Added:
>
>
 

Changed:
<
<
[Experiment]
>
>
[Experiment]
Block:
 
Changed:
<
<
Block: name descriptive for the sub-experiment to run
>
>
name descriptive for the sub-experiment to run
 Block = 'speller'
Added:
>
>
 

Revision 206 May 2009 - Main.PhilipVanDenBroek

Line: 1 to 1
 
META TOPICPARENT name="DocsSectionsGettingStarted"
[RunMode]
DataSource: defines what source is responsible for supplying the raw data to BrainStream.
Changed:
<
<
DataSource = '!BioSemiAcq' % BioSemi? 's Active2.
>
>
DataSource = 'BioSemiAcq' % BioSemi? 's Active2.
 DataSource = 'BDFFile' % from file, biosemi dataformat (.bdf).
DataSource = 'FileIO' % any file format supported by fieldtrip/FileIO (also fcdc_buffer).
DataSource = 'NoAcqSource' % simulates no data source, requested data will al be filled with zeros (NB: RealTime? will be forced to true).
Line: 11 to 11
 Subject: at the end, just before BrainStream stops executing your block, BrainStream copies the final state to the OutFolder? . The state contains all information BrainStream requires for its internal processing. This Subject's name is incorporated in the name of the corresponding mat-file.
Subject = 'a_subjects_name'

Changed:
<
<
SampleRateAfterDecimation: if incoming raw data needs to be downsampled in time, set this key to the desired value. The ratio between the acquisition sample rate and SampleRateAfterDecimation? must be a power of 2 and >= 1, i.e., 1,2,4,8 or 16. BrainStream applies a low-pass filter to the raw data before downsampling and for the filtering step it collects additional samples in order to provide the requested data epoch to the user (without filter edge effects). Be aware of the fact that it introduces a slightly delay in the moment data becomes available to the user.
>
>
SampleRateAfterDecimation: if incoming raw data needs to be downsampled in time, set this key to the desired value. The ratio between the acquisition sample rate and SampleRateAfterDecimation must be a power of 2 and >= 1, i.e., 1,2,4,8 or 16. BrainStream applies a low-pass filter to the raw data before downsampling and for the filtering step it collects additional samples in order to provide the requested data epoch to the user (without filter edge effects). Be aware of the fact that it introduces a slightly delay in the moment data becomes available to the user.
 SampleRateAfterDecimation = 256 % acquisition sample rate then should be 256Hz or 512, or 1024, or 2048 etc.

screenoutputlevel: sets the amount of information that is displayed during processing.
Line: 20 to 20
 screenoutputlevel = 'WARNING' % also displays warning messages.
screenoutputlevel = 'DEBUG' % also displays extra information about processed actions (use only in case debugging is required).

Changed:
<
<
TriggerSource: only used in case data source is FileIO? via fcdc_buffer via BCI2000. This way it is possible to manage incoming markers directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event.
>
>
TriggerSource: only used in case data source is FileIO via fcdc_buffer via BCI2000. This way it is possible to manage incoming markers directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event.
 NB, last channel is assumed to be the trigger channel!!!!
TriggerSource = 'trigger' (default = 'default')

TriggerDef: defines how trigger channel information should be translated into marker information.
TriggerDef = 'trigger_definitions.txt'

Changed:
<
<
DataFormat: only used in case data source is FileIO? via fcdc_buffer via BCI2000. This way it is possible to manage incoming markers directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event. Since the actual data acquisition source can be any BCI2000 supported device, DataFormat? should be defined so that BrainStream knows how to handle incoming trigger data.
>
>
DataFormat: only used in case data source is FileIO via fcdc_buffer via BCI2000. This way it is possible to manage incoming markers directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event. Since the actual data acquisition source can be any BCI2000 supported device, DataFormat? should be defined so that BrainStream knows how to handle incoming trigger data.
 DataFormat = 'biosemi_bdf' % currently the only supported one using BCI2000 via FileIO? . (warning, still needs to solve trigger channel filtering issue)

RealTime: use only in case running with an offline data source, i.e., from file or no data at all (DataSource? ='NoAcqSource'). Set this value to true in order to simulate real-time data processing. Set it to false if offline data processing should be done as quickly as possible.
Line: 43 to 43
 StimulusPresentationSource = 'Logic' (default)
StimuluspresentationSource = 'PsychToolBox'

Changed:
<
<
RecordStartIndex: defines from which record to start reading the file (only DataSource? =BDFFile)
>
>
RecordStartIndex: defines from which record to start reading the file (only DataSource=BDFFile)
 RecordStartIndex = 1 (default) only used in case data source is a biosemi .bdf file
Cap: defines which cap will be used at startup. User functions are responsible for changing hdr and current cap information after changing the cap (after spatial downsampling for example)
Line: 51 to 51
 Cap = 'biosemi_cap64'

CopyStimFiles: Set to true (default) if stimulus files need to be copied from bci_stims volume to the local stimulus presentation computer.
Changed:
<
<
CopyStimFiles? = 1
>
>
=CopyStimFiles = 1
 
LoadStimulusFile: set to true (default) to start Logic and load stimulus presentation file.
LoadStimulusFile? = 1
Deleted:
<
<

 

Changed:
<
<
[Files]
>
>
[Files]
 
Changed:
<
<
ReferenceFolder: defines the folder where the experiment definition file is located. Inside the tables relative path names are translated to absolute path names relative to this ReferenceFolder? . This key must be defined.
ReferenceFolder? = '/Volumes/bci_stims/my_experiment/'
>
>
ReferenceFolder: defines the folder where the experiment definition file is located. Inside the tables relative path names are translated to absolute path names relative to this ReferenceFolder? . This key must be defined.
ReferenceFolder = '/Volumes/bci_stims/my_experiment/'
 
OutFolder: defines path to location where BrainStream can store output. This key must be defined.
Changed:
<
<
OutFolder? = '/Volumes/bci_data/my_experiment/'
>
>
OutFolder = '/Volumes/bci_data/my_experiment/'
 
ExperimentDefinitionFile: the file that defines the experiment to run.
Changed:
<
<
ExperimentDefinitionFile? = '/Volumes/bci_stims/my_experiment/myblock.xls'
>
>
ExperimentDefinitionFile = '/Volumes/bci_stims/my_experiment/myblock.xls'
 
ExperimentDefinitionData: defines in which table or sheet BrainStream can find information about which markers request data for their actions.
Changed:
<
<
ExperimentDefinitionData? = 'DataSelection' (=default)
>
>
ExperimentDefinitionData = 'DataSelection' (=default)
 
ExperimentDefinitionSubFile : defines from which table or sheet BrainStream should start reading markers' actions.
Changed:
<
<
ExperimentDefinitionSubFile? = 'Actions' (=default)
>
>
ExperimentDefinitionSubFile = 'Actions' (=default)
 
DataFile (deprecated!, don't use these keys)
Changed:
<
<
DataFileDir? (deprecated!, don't use these keys)
>
>
DataFileDir (deprecated!, don't use these keys)
 
StimulusFile: defines Logic stimulus presentation file
Changed:
<
<
StimulusFile? = '/Volumes/bci_stims/my_experiment/logic/myblock.lso'

ActiviewConfigFile: defines settings for Actiview to control BioSemi? 's Active2 acquisition, i.e., number of acquired channels, sample rate etc.
ActiviewConfigFile? = 'Actiview_MMMdefault.cfg' (default)
or, Actiview_MMMdefault_cap64.cfg, Actiview_MMMaib_cap64.cfg, Actiview_MMMaib.cfg,
>
>
StimulusFile = '/Volumes/bci_stims/my_experiment/logic/myblock.lso'
 
Added:
>
>
ActiviewConfigFile: defines settings for Actiview to control BioSemi's Active2 acquisition, i.e., number of acquired channels, sample rate etc.
ActiviewConfigFile = 'Actiview_MMMdefault.cfg' (default)
ActiviewConfigFile = 'Actiview_MMMdefault_cap64.cfg'
ActiviewConfigFile = 'Actiview_MMMaib_cap64.cfg'
ActiviewConfigFile = 'Actiview_MMMaib.cfg'
 

Line: 94 to 94
 [BiosemiAcq]
Host: ip number of host running Actiview
Changed:
<
<
Host = '123.456.789.100' (or 'localhost', or 'server.dcc.ru.nl')
>
>
Host = '123.456.789.100' (or 'localhost', or 'server.dcc.ru.nl')
 
Port: port to connect to on host running Actiview
Changed:
<
<
Port = 5050

>
>
Port = 5050
 

Line: 106 to 105
 [Experiment]
Block: name descriptive for the sub-experiment to run
Changed:
<
<
Block = 'speller'

>
>
Block = 'speller'
 

Revision 106 May 2009 - Main.PhilipVanDenBroek

Line: 1 to 1
Added:
>
>
META TOPICPARENT name="DocsSectionsGettingStarted"
[RunMode]
DataSource: defines what source is responsible for supplying the raw data to BrainStream.
DataSource = '!BioSemiAcq' % BioSemi? 's Active2.
DataSource = 'BDFFile' % from file, biosemi dataformat (.bdf).
DataSource = 'FileIO' % any file format supported by fieldtrip/FileIO (also fcdc_buffer).
DataSource = 'NoAcqSource' % simulates no data source, requested data will al be filled with zeros (NB: RealTime? will be forced to true).

Subject: at the end, just before BrainStream stops executing your block, BrainStream copies the final state to the OutFolder? . The state contains all information BrainStream requires for its internal processing. This Subject's name is incorporated in the name of the corresponding mat-file.
Subject = 'a_subjects_name'

SampleRateAfterDecimation: if incoming raw data needs to be downsampled in time, set this key to the desired value. The ratio between the acquisition sample rate and SampleRateAfterDecimation? must be a power of 2 and >= 1, i.e., 1,2,4,8 or 16. BrainStream applies a low-pass filter to the raw data before downsampling and for the filtering step it collects additional samples in order to provide the requested data epoch to the user (without filter edge effects). Be aware of the fact that it introduces a slightly delay in the moment data becomes available to the user.
SampleRateAfterDecimation = 256 % acquisition sample rate then should be 256Hz or 512, or 1024, or 2048 etc.

screenoutputlevel: sets the amount of information that is displayed during processing.
screenoutputlevel = 'ERROR' % (default) only displays errors and approximately every 10 seconds it indicates progress made.
screenoutputlevel = 'INFO' % also displays which markers' actions are currently being processed in Matlab command window.
screenoutputlevel = 'WARNING' % also displays warning messages.
screenoutputlevel = 'DEBUG' % also displays extra information about processed actions (use only in case debugging is required).

TriggerSource: only used in case data source is FileIO? via fcdc_buffer via BCI2000. This way it is possible to manage incoming markers directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event.
NB, last channel is assumed to be the trigger channel!!!!
TriggerSource = 'trigger' (default = 'default')

TriggerDef: defines how trigger channel information should be translated into marker information.
TriggerDef = 'trigger_definitions.txt'

DataFormat: only used in case data source is FileIO? via fcdc_buffer via BCI2000. This way it is possible to manage incoming markers directly from the trigger channel and read_event is not used. Otherwise, custom markers wouldn't be processed since they are not recognized by read_event. Since the actual data acquisition source can be any BCI2000 supported device, DataFormat? should be defined so that BrainStream knows how to handle incoming trigger data.
DataFormat = 'biosemi_bdf' % currently the only supported one using BCI2000 via FileIO? . (warning, still needs to solve trigger channel filtering issue)

RealTime: use only in case running with an offline data source, i.e., from file or no data at all (DataSource? ='NoAcqSource'). Set this value to true in order to simulate real-time data processing. Set it to false if offline data processing should be done as quickly as possible.
RealTime = true (or 1)

Parallel: set to true to enable parallel processing of markers' actions. In the experiment definition table it needs to be specified which markers actions are allowed to be processed in parallel. See .... for more details.
Parallel = true (or 1, default = false)

NumCores: in case BrainStreams parallel running mode is set to true, this key specifies the number of cores BrainStream should utilize for its parallel processing. Every additional core will then run a separate Matlab session. The Matlab session running BrainStream itself will dedicate jobs to these extra `matlab sessions dependent of how users have configured their experiment definition tables. See .... for more details.
Numcores = 4

StimulusPresentationSource? : defines stimulus presentation source.
StimulusPresentationSource = 'Logic' (default)
StimuluspresentationSource = 'PsychToolBox'

RecordStartIndex: defines from which record to start reading the file (only DataSource? =BDFFile)
RecordStartIndex = 1 (default) only used in case data source is a biosemi .bdf file
Cap: defines which cap will be used at startup. User functions are responsible for changing hdr and current cap information after changing the cap (after spatial downsampling for example)
Cap = 'biosemi_cap256'
Cap = 'biosemi_cap64'

CopyStimFiles: Set to true (default) if stimulus files need to be copied from bci_stims volume to the local stimulus presentation computer.
CopyStimFiles? = 1

LoadStimulusFile: set to true (default) to start Logic and load stimulus presentation file.
LoadStimulusFile? = 1



[Files]

ReferenceFolder: defines the folder where the experiment definition file is located. Inside the tables relative path names are translated to absolute path names relative to this ReferenceFolder? . This key must be defined.
ReferenceFolder? = '/Volumes/bci_stims/my_experiment/'

OutFolder: defines path to location where BrainStream can store output. This key must be defined.
OutFolder? = '/Volumes/bci_data/my_experiment/'

ExperimentDefinitionFile: the file that defines the experiment to run.
ExperimentDefinitionFile? = '/Volumes/bci_stims/my_experiment/myblock.xls'

ExperimentDefinitionData: defines in which table or sheet BrainStream can find information about which markers request data for their actions.
ExperimentDefinitionData? = 'DataSelection' (=default)

ExperimentDefinitionSubFile : defines from which table or sheet BrainStream should start reading markers' actions.
ExperimentDefinitionSubFile? = 'Actions' (=default)

DataFile (deprecated!, don't use these keys)
DataFileDir? (deprecated!, don't use these keys)

StimulusFile: defines Logic stimulus presentation file
StimulusFile? = '/Volumes/bci_stims/my_experiment/logic/myblock.lso'

ActiviewConfigFile: defines settings for Actiview to control BioSemi? 's Active2 acquisition, i.e., number of acquired channels, sample rate etc.
ActiviewConfigFile? = 'Actiview_MMMdefault.cfg' (default)
or, Actiview_MMMdefault_cap64.cfg, Actiview_MMMaib_cap64.cfg, Actiview_MMMaib.cfg,



[BiosemiAcq]

Host: ip number of host running Actiview
Host = '123.456.789.100' (or 'localhost', or 'server.dcc.ru.nl')

Port: port to connect to on host running Actiview
Port = 5050



[Experiment]

Block: name descriptive for the sub-experiment to run
Block = 'speller'



 
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback