Line 13: |
Line 13: |
| | | |
| Input | | Input |
− | {| border="1" | + | {| class="wikitable" |
| |- | | |- |
| | <tt>event</tt> || BrainStream event structure | | | <tt>event</tt> || BrainStream event structure |
Line 28: |
Line 28: |
| | | |
| Output | | Output |
− | {| border="1" | + | {| class="wikitable" |
| |- | | |- |
| | <tt>value</tt> || content of requested key or default value if specified, otherwise an error is generated. Blocksettings structure if first argument is a filename | | | <tt>value</tt> || content of requested key or default value if specified, otherwise an error is generated. Blocksettings structure if first argument is a filename |
Line 47: |
Line 47: |
| | | |
| Input | | Input |
− | {| border="1" | + | {| class="wikitable" |
| |- | | |- |
| | <tt>input</tt> || either blocksettings structure or the name of a blocksettings file, the latter option is useful to retrieveclean block file content without any comment lines | | | <tt>input</tt> || either blocksettings structure or the name of a blocksettings file, the latter option is useful to retrieveclean block file content without any comment lines |
Line 56: |
Line 56: |
| | | |
| Output | | Output |
− | {| border="1" | + | {| class="wikitable" |
| |- | | |- |
| | lines || cell array of lines (one per row) | | | lines || cell array of lines (one per row) |
Line 72: |
Line 72: |
| | | |
| Input | | Input |
− | {| border="1" | + | {| class="wikitable" |
| |- | | |- |
| | expression || some expression that either results in true or false | | | expression || some expression that either results in true or false |
Line 83: |
Line 83: |
| | | |
| Output | | Output |
− | {| border="1" | + | {| class="wikitable" |
| |- | | |- |
| | opttrue || if expression is true | | | opttrue || if expression is true |
Line 99: |
Line 99: |
| | | |
| Input | | Input |
− | {| border="1" | + | {| class="wikitable" |
| |- | | |- |
| | filename || name of blockfile with defined experiment definition table to be expanded | | | filename || name of blockfile with defined experiment definition table to be expanded |
Line 108: |
Line 108: |
| | | |
| Output | | Output |
− | {| border="1" | + | {| class="wikitable" |
| |- | | |- |
| | markers || all info BrainStream requires for its internal processing <br /> definition of all actions for all markers | | | markers || all info BrainStream requires for its internal processing <br /> definition of all actions for all markers |
Line 130: |
Line 130: |
| | | |
| Input | | Input |
− | {| border="1" | + | {| class="wikitable" |
| |- | | |- |
| | url || string with name of the datafile or fieldtrip buffer url (i.e., something like: 'buffer://localhost:1972') | | | url || string with name of the datafile or fieldtrip buffer url (i.e., something like: 'buffer://localhost:1972') |
Line 213: |
Line 213: |
| | | |
| Input | | Input |
− | {| border="1" | + | {| class="wikitable" |
| |- | | |- |
− | | event || BrainStream event structure | | + | | event || colspan=2|BrainStream event structure |
| |- | | |- |
− | | mod || specifies what information to retrieve, options are: | | + | | mod || colspan=2|specifies what information to retrieve, options are: |
| |- | | |- |
− | | ^ || 'LOGFILE' || name of the logfile | + | | || 'LOGFILE' || name of the logfile |
| |} | | |} |
| | | |
| Output | | Output |
− | {| border="1" | + | {| class="wikitable" |
| |- | | |- |
| | value || requested info, dependent of mod | | | value || requested info, dependent of mod |
Line 236: |
Line 236: |
| | | |
| Input | | Input |
− | {| border="1" | + | {| class="wikitable" |
| |- | | |- |
− | | event || BrainStream event structure (optional) | | + | | event ||colspan=2| BrainStream event structure (optional) |
| |- | | |- |
− | | text || string with requested folder reference | | + | | text ||colspan=2| string with requested folder reference |
| |- | | |- |
− | | ^ || 'RUNFOLDER' || folder with system related content | + | | || 'RUNFOLDER' || folder with system related content |
| |- | | |- |
− | | ^ || 'BLOCK' || folder with block file | + | | || 'BLOCK' || folder with block file |
| |- | | |- |
− | | ^ || 'SESSIONFOLDER' || folder with session related content | + | | || 'SESSIONFOLDER' || folder with session related content |
| |- | | |- |
− | | ^ || 'SUBJECTFOLDER' || folder with subject related content | + | | || 'SUBJECTFOLDER' || folder with subject related content |
| |- | | |- |
− | | ^ || 'EXPERIMENTFOLDER' || folder with experiment related content | + | | || 'EXPERIMENTFOLDER' || folder with experiment related content |
| |- | | |- |
− | | ^ || 'REFERENCEFOLDER' || folder with currently executed blockfile | + | | || 'REFERENCEFOLDER' || folder with currently executed blockfile |
| |- | | |- |
− | | ^ || 'BRAINSTREAMFOLDER' || brainstream core folder | + | | || 'BRAINSTREAMFOLDER' || brainstream core folder |
| |- | | |- |
− | | ^ || 'ROOT' || brainstream root folder | + | | || 'ROOT' || brainstream root folder |
| |- | | |- |
− | | ^ || 'RESOURCESFOLDER' || folder with user resources | + | | || 'RESOURCESFOLDER' || folder with user resources |
| |- | | |- |
− | | ^ || 'LIBFOLDER' || folder with library tables | + | | || 'LIBFOLDER' || folder with library tables |
| |- | | |- |
− | | ^ || 'PLUGINSFOLDER' || folder with plugin tables | + | | || 'PLUGINSFOLDER' || folder with plugin tables |
| |- | | |- |
− | | ^ || 'FIELDTRIPFOLDER' || fieldtrip toolbox folder | + | | || 'FIELDTRIPFOLDER' || fieldtrip toolbox folder |
| |- | | |- |
− | | ^ || 'EXAMPLES' || folder with examples | + | | || 'EXAMPLES' || folder with examples |
| |- | | |- |
− | | ^ || 'TOOLBOXES' || folder with internally included toolboxes | + | | || 'TOOLBOXES' || folder with internally included toolboxes |
| |} | | |} |
| | | |
| See also: | | See also: |
| + | |
| === bs_disp === | | === bs_disp === |
| bs_disp() outputs text to console (or screen). It is a wrapper function around Matlab disp function, intended to be used as function in the experiment definition table for displaying output to screen. Instead, you could also directly define the disp() function in the special [.DocsSectionsBuildingExperiments#SecFeval feval] column. | | bs_disp() outputs text to console (or screen). It is a wrapper function around Matlab disp function, intended to be used as function in the experiment definition table for displaying output to screen. Instead, you could also directly define the disp() function in the special [.DocsSectionsBuildingExperiments#SecFeval feval] column. |
Line 278: |
Line 279: |
| | | |
| Input | | Input |
− | {| border="1" | + | {| class="wikitable" |
| |- | | |- |
| | event || BrainStream event structure | | | event || BrainStream event structure |
Line 298: |
Line 299: |
| | | |
| Input | | Input |
− | {| border="1" | + | {| class="wikitable" |
| |- | | |- |
| | event || BrainStream event structure | | | event || BrainStream event structure |
Line 316: |
Line 317: |
| | | |
| Input | | Input |
− | {| border="1" | + | {| class="wikitable" |
| |- | | |- |
| | event || BrainStream event structure | | | event || BrainStream event structure |
Line 339: |
Line 340: |
| <pre>bs_send_hardware_marker(event, marker, datasource)</pre>Input | | <pre>bs_send_hardware_marker(event, marker, datasource)</pre>Input |
| | | |
− | {| border="1" | + | {| class="wikitable" |
| |- | | |- |
| | event || event structure | | | event || event structure |
Line 360: |
Line 361: |
| <pre>bs_send_buffer_marker(event, marker, datasource, delay, reference)</pre>Input | | <pre>bs_send_buffer_marker(event, marker, datasource, delay, reference)</pre>Input |
| | | |
− | {| border="1" | + | {| class="wikitable" |
| |- | | |- |
| | event || event structure | | | event || event structure |
Line 372: |
Line 373: |
| | reference || relative to which timepoint is the delay specified, either: | | | reference || relative to which timepoint is the delay specified, either: |
| |- | | |- |
− | | ^ || 'now': delay is specified relative to timepoint of bs_send_buffer_marker execution | + | | || 'now': delay is specified relative to timepoint of bs_send_buffer_marker execution |
| |- | | |- |
− | | ^ || 'marker' (default): delay is specified relative to the onset of the event during which bs_send_buffer_marker is executed | + | | || 'marker' (default): delay is specified relative to the onset of the event during which bs_send_buffer_marker is executed |
| |} | | |} |
| | | |
Line 382: |
Line 383: |
| | | |
| === bs_insert_marker === | | === bs_insert_marker === |
− | This function is deprecated, use bs_send_hardware_marker and bs_send_buffer_marker instead.
| + | This function is deprecated, use bs_send_hardware_marker and bs_send_buffer_marker instead. |
| | | |
| === bs_insert_multiple_markers === | | === bs_insert_multiple_markers === |
Line 391: |
Line 392: |
| | | |
| Input | | Input |
− | {| border="1" | + | {| class="wikitable" |
| |- | | |- |
− | | event || BrainStream event structure | | + | | event || colspan="2"|BrainStream event structure |
| |- | | |- |
− | | name || name of the marker | | + | | name || colspan="2"|name of the marker |
| |- | | |- |
− | | delaytime || time of insertion in seconds relative to actions own execution time (>=0)y | | + | | delaytime || colspan="2"|time of insertion in seconds relative to actions own execution time (>=0)y |
| |- | | |- |
− | | interval || time in seconds between insertions of markers | | + | | interval || colspan="2"|time in seconds between insertions of markers |
| |- | | |- |
− | | number || number of times the marker has to be inserted | | + | | number || colspan="2"|number of times the marker has to be inserted |
| |- | | |- |
− | | priority || <p>option to change execution order in case multiple actions have equal execution times</p> | | + | | priority || colspan="2"|<p>option to change execution order in case multiple actions have equal execution times</p> |
| |- | | |- |
− | | ^ || 'low' || (default) put behind all other actions with equal execution times | + | | || 'low' || (default) put behind all other actions with equal execution times |
| |- | | |- |
− | | ^ || 'high' || put before all other actions with equal execution times | + | | || 'high' || put before all other actions with equal execution times |
| |} | | |} |
| | | |
Line 419: |
Line 420: |
| | | |
| Input | | Input |
− | {| border="1" | + | {| class="wikitable" |
| |- | | |- |
− | | event || BrainStream event structure ||| | + | | event || colspan="3"|BrainStream event structure |
| |- | | |- |
− | | mod || modifier indicating what needs to change in the scheduled processing ||| | + | | mod || colspan="3"|modifier indicating what needs to change in the scheduled processing |
| |- | | |- |
− | | ^ || options for mod: ||| | + | | || colspan="3"|options for mod: |
| |- | | |- |
− | | ^ || ^ || 'FINISHAPPLICATION' || finish application, normal shutdown via BS EXIT | + | | || || 'FINISHAPPLICATION' || finish application, normal shutdown via BS EXIT |
| |- | | |- |
− | | ^ || ^ || 'FINISHEXPERIMENT' || same as FINISHAPPLICATION | + | | || || 'FINISHEXPERIMENT' || same as FINISHAPPLICATION |
| |- | | |- |
− | | ^ || ^ || 'QUITAPPLICATION' || quit application, alternative shutdown via BS QUIT | + | | || || 'QUITAPPLICATION' || quit application, alternative shutdown via BS QUIT |
| |- | | |- |
− | | ^ || ^ || 'QUITEXPERIMENT' || same as QUITAPPLICATION | + | | || || 'QUITEXPERIMENT' || same as QUITAPPLICATION |
| |- | | |- |
− | | ^ || ^ || 'FINISHEVENT' || discard execution of any queued actions for this event | + | | || || 'FINISHEVENT' || discard execution of any queued actions for this event |
| |- | | |- |
− | | ^ || ^ || 'ABORTAPPLICATION' || immediately abort | + | | || || 'ABORTAPPLICATION' || immediately abort |
| |} | | |} |
| | | |