Wiki-admin: /* Topics and keys for block files */

2018-09-26T10:34:11Z

Topics and keys for block files

← Older revision		Revision as of 10:34, 26 September 2018
Line 25:		Line 25:

	'''DataSource''':		'''DataSource''':
	<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px">This key is deprecated, define under topic [[~~.DocsSectionsBlockFile~~#TopicDataSources DataSources]] instead. </blockquote><blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"><blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> </blockquote> </blockquote>		<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px">This key is deprecated, define under topic [ [[BrainStreamBlockFile#TopicDataSources\|DataSources]] ] instead. </blockquote><blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"><blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> </blockquote> </blockquote>

	'''SampleRateAfterDecimation''':		'''SampleRateAfterDecimation''':

Wiki-admin: /* Topics and keys for block files */

2018-09-26T10:31:58Z

Topics and keys for block files

← Older revision		Revision as of 10:31, 26 September 2018
Line 10:		Line 10:

	'''*<datasource>''':		'''*<datasource>''':
	<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px">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 [~~.DocsSectionsDataSources~~ Connecting Data Sources]). This key is obligatory. <br /> <tt><datasource> = '<buffer address>:<port>:<device>' %acquisition device<br /><datasource> = '<data file>:<device>' %recorded data file<br /><datasource> = 'simulate:<device>' %simulated data</tt> <blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> <br /></blockquote></blockquote></blockquote>		<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px">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 [[BrainStreamDataSources\|Connecting Data Sources]]). This key is obligatory. <br /> <tt><datasource> = '<buffer address>:<port>:<device>' %acquisition device<br /><datasource> = '<data file>:<device>' %recorded data file<br /><datasource> = 'simulate:<device>' %simulated data</tt> <blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> <br /></blockquote></blockquote></blockquote>

	<div id="TopicRunMode"></div>		<div id="TopicRunMode"></div>

Wiki-admin: Created page with " = Topics and keys for block files = NOTOC In your block files, two topics are always required: DataSources with..."

2018-09-26T10:31:15Z

Created page with " = Topics and keys for block files = __NOTOC__ In your block files, two topics are always required: DataSources with..."

New page

= Topics and keys for block files =
__NOTOC__
In your [[BrainStreamBuildingExperiments#SecBlock|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.

<div id="TopicDataSources"></div>

'''[DataSources]'''
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px">

'''*<datasource>''':
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px">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 [.DocsSectionsDataSources Connecting Data Sources]). This key is obligatory. <br /> <tt><datasource> = '<buffer address>:<port>:<device>' %acquisition device<br /><datasource> = '<data file>:<device>' %recorded data file<br /><datasource> = 'simulate:<device>' %simulated data</tt> <blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> <br /></blockquote></blockquote></blockquote>

<div id="TopicRunMode"></div>

'''[RunMode]'''
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px">

</blockquote> <blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px">

'''*Subject''': (automatically included if starting using the GUI)
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> 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. <br /> <tt>Subject = 'a_subjects_name'</tt> </blockquote><blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> </blockquote></blockquote>

<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px">

'''DataSource''':
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px">This key is deprecated, define under topic [[.DocsSectionsBlockFile#TopicDataSources DataSources]] instead. </blockquote><blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"><blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> </blockquote> </blockquote>

'''SampleRateAfterDecimation''':
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> This key is deprecated, define in [[BrainStreamInstallation#HardwareSetup|configuration file]] instead.</blockquote></blockquote>

<div id="KeyScreenOutput"></div>
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px">

'''screenoutputlevel''':
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> This key is deprecated, use [[BrainStreamBlockFile#KeyVerbosityLevel|VerbosityLevel]] instead.</blockquote></blockquote>

<div id="KeyVerbosityLevel"></div>
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px">

'''VerbosityLevel''':
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> sets the amount of information that is displayed during processing. <br /> <tt>VerbosityLevel</tt> = 'ERROR' % (default) only displays errors and approximately every 10 seconds it indicates progress made.<br /> <tt>VerbosityLevel</tt> = 'INFO' % also displays which markers' actions are currently being processed in Matlab command window. <br /> <tt>VerbosityLevel</tt> = 'WARNING' % also displays warning messages. <br /> <tt>VerbosityLevel</tt> = 'DEBUG' % also displays extra information about processed actions (use only in case debugging is required).<br /><br /> </blockquote><blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"><blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> </blockquote></blockquote>

'''RealTime''':
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px">This key is deprecated. <br /> </blockquote></blockquote><blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"><blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> </blockquote>

'''Parallel''':
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> 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. <br /> <tt>Parallel = true</tt> % (or 1, default = false) <br /> </blockquote></blockquote><blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"><blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> </blockquote>

'''NumCores''':
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> 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. <br /> <tt>Numcores = 4</tt> <br /> </blockquote></blockquote> <blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px">

'''Cap''':
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> This key is deprecated. Specify under topic [ [[BrainStreamBlockFile#TopicDatasource|<datasource>]] ] or [ [[BrainStreamBlockFile#TopicDevice|<device>]] ] instead. </blockquote></blockquote> <blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px">

'''DataType''':
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> defines type of raw data retrieved from BrainStream. <br /> <tt>DataType = 'single'</tt> (default) <br /> <tt>DataType = 'double'</tt> <br /> </blockquote></blockquote>

<div id="TopicFiles"></div>

'''[Files]'''
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px">

'''*ReferenceFolder''': (automatically included if starting using the GUI)
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> 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.</blockquote><blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> <tt>ReferenceFolder = '/Volumes/bci_stims/my_experiment/'</tt> <br /> <br /> </blockquote>

<div id="KeyOutFolder"></div>

'''*OutFolder''':
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> defines path to location where BrainStream can store output. This key is obligatory.<br /> <tt>OutFolder = '/Volumes/bci_data/my_experiment/'</tt> <br /> <br /> </blockquote>

'''*ExperimentDefinitionFile''':
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> the file containing the [[BrainStreamBuildingExperiments#SecExpDef|experiment definition tables]] (.xls or .edt). This key is obligatory.<br /> <tt>ExperimentDefinitionFile = '/Volumes/bci_stims/my_experiment/myblock.xls'</tt> <br /> <br /> </blockquote>

'''ExperimentDefinitionData''':
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px">This key is deprecated. <br /> <br /> </blockquote>

'''ExperimentDefinitionSubFile''':
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px">This key is deprecated.</blockquote><blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> </blockquote>

'''StimulusFile''':
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px">This key is deprecated. <br /> <br /> </blockquote>

'''ActiviewConfigFile''':
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px">This key is deprecated. </blockquote> </blockquote>

<div id="TopicExperiment"></div>

'''[Experiment]'''
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px">

'''*Block''':
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> name descriptive for the sub-experiment (i.e. block) to run <br /> <tt>Block = 'speller'</tt> </blockquote>

<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> </blockquote>

'''MatlabPathFnc''':
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> specify function to call by BrainStream for setting Matlab path <br /> <tt>MatlabPathFnc = 'setREPOSpath('get_app_folders({''myexperiment''}))'</tt> </blockquote><blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> </blockquote>

<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> </blockquote> '''MatlabPathAdd:''' <br /> <blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> specify list of extra folders to add to Matlab path </blockquote> <blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> <tt>MatlabPathAdd = {'/Volumes/code/my_experiments/',fullfile(get_repos_root,'/own_experiments/visual/')}</tt> </blockquote> </blockquote>

<div id="TopicClients"></div>

'''[Clients]'''
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px">

'''<name of client>''':

<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> translates client name (descriptive for the actions that execute parallel-wise) into DNS name or ip-number.<br /> <tt>client1 = '131.174.123.456'</tt> <br /> <tt>client2 = 'eegstim.mydomain.nl'</tt> <br /> <tt>client3 = 'core1' % dedicate/reserve specific core</tt> <br /> <tt>client4 = 'cores' % BrainStream picks first available core</tt> <br /> <tt>client5 = 'local' % execute serial-wise (overruled; no parallel execution)</tt> <br /><br /> </blockquote><blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> </blockquote><blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> </blockquote></blockquote>

<div id="TopicClient"></div>

<strong>[<client>] </strong>(name of the client specified under topic [ [[BrainStreamBlockFile#TopicClients|Clients]] ])
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px">

'''MatlabPathAdd:'''
<blockquote style="padding: 0px; border-style: none; margin: 0px 0px 0px 40px">specify list of extra folders to add to the clients Matlab path</blockquote><blockquote style="padding: 0px; border-style: none; margin: 0px 0px 0px 40px">MatlabPathAdd = {'/Volumes/code/my_experiments/'} </blockquote></blockquote>

<div id="TopicDatasource"></div>

<strong>[<datasource>] </strong>(name of the data source specified under topic [ [[BrainStreamBlockFile#TopicDataSources|DataSources]] ])
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px">

'''Cap''':
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> 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).</blockquote><blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> <tt>Cap = 'cap256.txt'</tt> <br /> <tt>Cap = 'cap64.txt'</tt> </blockquote></blockquote>

<div id="TopicDevice"></div>

<strong>[<device>] </strong>(name of the acquisition device specified under topic [ [[BrainStreamBlockFile#TopicDataSources|DataSources]] ])
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px">

'''Cap''':
<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> 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).</blockquote><blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> <tt>Cap = 'cap_emotiv_epoch.txt'</tt> <br /> <tt>Cap = 'cap_neurosky_thinkgear.txt'</tt> </blockquote></blockquote>

<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> '''SendMarkerFnc''':<blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px">defines which [[BrainStreamInstallation#HardwareMarkers|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 [.DocsSectionsMarkerHandling here].<br /> <tt>SendMarkerFnc = 'sndBufferMarker' %default</tt> <br /></blockquote><blockquote style="border-style: none; margin: 0px 0px 0px 40px; padding: 0px"> <br /></blockquote></blockquote>

BrainStreamBlockFile - Revision history

Wiki-admin: /* Topics and keys for block files */

Wiki-admin: /* Topics and keys for block files */

Wiki-admin: Created page with " = Topics and keys for block files = __NOTOC__ In your block files, two topics are always required: DataSources with..."

Wiki-admin: Created page with " = Topics and keys for block files = NOTOC In your block files, two topics are always required: DataSources with..."