Changes

__TOC__

__TOC__

BrainStream creates a log file for each block of your experiment. The log file gives an overview of everything that happened during your experiment. You can find the log file in the [.DocsSectionsPathsFolders#OutputFolder runfolder] of your experiment.

BrainStream creates a log file for each block of your experiment. The log file gives an overview of everything that happened during your experiment. You can find the log file in the [[BrainStreamPathsFolders#OutputFolder|runfolder]] of your experiment.

As the log file contains a lot of information it is sometimes difficult to find the information you are looking for. In the following, we will show which information is included in the log file and where it can be found. We will use [[File:BrainStreamDocs_Log-09Nov2011-10h47m38s.docx|this]] log file as an example. The log file belongs to the experiment described [.DocsSectionsExampleSentences here].

As the log file contains a lot of information it is sometimes difficult to find the information you are looking for. In the following, we will show which information is included in the log file and where it can be found. We will use [[File:BrainStreamDocs_Log-09Nov2011-10h47m38s.docx|this]] log file as an example. The log file belongs to the experiment described [[BrainStreamExampleSentences|here]].

== Date and time ==

== Date and time ==

<pre>09Nov11|10:47:38.928 INFO ></pre>

<pre>09Nov11|10:47:38.928 INFO ></pre>

Date and time are derived from the computer which executes the actions. Note that if you are using [.DocsSectionsParallelMode#SecClients parallel clients] on multiple computers, computer times of the different machines may not be synchronous. Although this may be confusing when reading the log file, it has no influence on the timing of executed actions.

Date and time are derived from the computer which executes the actions. Note that if you are using [[BrainStreamParallelMode#SecClients|parallel clients]] on multiple computers, computer times of the different machines may not be synchronous. Although this may be confusing when reading the log file, it has no influence on the timing of executed actions.

The date and time can be followed either by INFO or WARN. This is related to the blocksetting [.DocsSectionsBlockFile#KeyVerbosityLevel VerbosityLevel]. If VerbosityLevel was set to INFO, all information in INFO '''and''' WARN lines of the log file have also been shown in the Matlab command window during the experiment. If VerbosityLevel was set to WARNING, only the WARN lines of the log file have been shown in the Matlab command window. Additionally, you can use the <tt>[.DocsSectionsProgrmmersGuide#bs_msg bs_msg]</tt> and <tt>[.DocsSectionsProgrmmersGuide#bs_warn bs_warn]</tt> functions to write messages to the log file yourself.

The date and time can be followed either by INFO or WARN. This is related to the blocksetting [[BrainStreamBlockFile#KeyVerbosityLevel|VerbosityLevel]]. If VerbosityLevel was set to INFO, all information in INFO '''and''' WARN lines of the log file have also been shown in the Matlab command window during the experiment. If VerbosityLevel was set to WARNING, only the WARN lines of the log file have been shown in the Matlab command window. Additionally, you can use the <tt>[[BrainStreamProgrmmersGuide#bs_msg|bs_msg]]</tt> and <tt>[[BrainStreamProgrmmersGuide#bs_warn|bs_warn]]</tt> functions to write messages to the log file yourself.

== Experiment initialization ==

== Experiment initialization ==

The first part of the log file describes everything that happened before the onset of BrainStream processing, that is, before the BS_INIT marker arrives. For example, you may find information about

The first part of the log file describes everything that happened before the onset of BrainStream processing, that is, before the BS_INIT marker arrives. For example, you may find information about

* reading settings from the [.DocsSectionsBuildingExperiments#SecBlock block file]<br />

* reading settings from the [[BrainStreamBuildingExperiments#SecBlock|block file]]<br />

<pre>

<pre>

09Nov11|10:47:46.593 INFO > Read from block settings: [[TriggerSource|Trigger Source]] = default

09Nov11|10:47:46.593 INFO > Read from block settings: [[TriggerSource|Trigger Source]] = default

09Nov11|10:47:48.248 INFO > Preload user defined function

09Nov11|10:47:48.248 INFO > Preload user defined function

</pre>

</pre>

* connecting to the FieldTrip buffer or [.DocsSectionsParallelMode#SecClients clients]<br />

* connecting to the FieldTrip buffer or [[BrainStreamParallelMode#SecClients|clients]]<br />

<pre>

<pre>

09Nov11|10:47:39.186 INFO > Initialize streaming from simulated data to: buffer://localhost:1975

09Nov11|10:47:39.186 INFO > Initialize streaming from simulated data to: buffer://localhost:1975

== Expanded Actions table ==

== Expanded Actions table ==

In addition, the log file always contains the [.DocsSectionsPlugIns#TableExpansion expanded] [.DocsSectionsBuildingExperiments#SecActions Actions table]. Although it looks a bit messy, it has the exact same content as the Actions table in your .edt or .xls file.

In addition, the log file always contains the [.DocsSectionsPlugIns#TableExpansion expanded] [[BrainStreamBuildingExperiments#SecActions|Actions table]]. Although it looks a bit messy, it has the exact same content as the Actions table in your .edt or .xls file.

<pre>09Nov11|10:47:48.241 INFO > Combined complete experiment definition table:

<pre>09Nov11|10:47:48.241 INFO > Combined complete experiment definition table:

marker time function feval looptick client stimsequence character sequence_count epoch_count fig

marker time function feval looptick client stimsequence character sequence_count epoch_count fig

<pre>09Nov11|10:47:49.132 INFO > Start of Brainstream processing, initialize block </pre>

<pre>09Nov11|10:47:49.132 INFO > Start of Brainstream processing, initialize block </pre>

In the following section of the log file, each line of asterisks separates actions belonging to different [.DocsSectionsImportantConcepts#SecEvents events]. The name of the event is shown in brackets.

In the following section of the log file, each line of asterisks separates actions belonging to different [[BrainStreamImportantConcepts#SecEvents|events]]. The name of the event is shown in brackets.

=== Action execution ===

=== Action execution ===

In the example experiment of this log file, the BS_INIT marker triggered the modification of three user defined variables and the execution of a function. According to the [.DocsSectionsTableHandling fixed order] in which BrainStream executes actions, first the modification actions are completed and then the function is executed. This is the information in the log file:

In the example experiment of this log file, the BS_INIT marker triggered the modification of three user defined variables and the execution of a function. According to the [[BrainStreamTableHandling|fixed order]] in which BrainStream executes actions, first the modification actions are completed and then the function is executed. This is the information in the log file:

<pre>09Nov11|10:47:49.155 INFO > '''***''' (                  BS_INIT) '''*************************************************************'''

<pre>09Nov11|10:47:49.155 INFO > '''***''' (                  BS_INIT) '''*************************************************************'''

09Nov11|10:47:49.156 INFO >   9.80 (eeg:#1.00)    9.80    10.66 act: modvar (t=EVENT) BS_INIT

09Nov11|10:47:49.156 INFO >   9.80 (eeg:#1.00)    9.80    10.66 act: modvar (t=EVENT) BS_INIT

The second number specifies the time at which the actions described in this line of the log file were scheduled to take place, whereas the third number specifies the time at which the action actually was executed. In the Actions table of the example experiment, all actions for the BS_INIT marker were scheduled for execution at time point EVENT, that is, as soon as the marker arrives. Thus, the scheduled time point is equal to the time of marker arrival. The third row shows that the modification actions took place 860 ms after the scheduled time, followed by the function execution 870 ms after the scheduled time.

The second number specifies the time at which the actions described in this line of the log file were scheduled to take place, whereas the third number specifies the time at which the action actually was executed. In the Actions table of the example experiment, all actions for the BS_INIT marker were scheduled for execution at time point EVENT, that is, as soon as the marker arrives. Thus, the scheduled time point is equal to the time of marker arrival. The third row shows that the modification actions took place 860 ms after the scheduled time, followed by the function execution 870 ms after the scheduled time.

The fourth column shows the [.DocsSectionsTableHandling#ActionType type] of action that is executed: retrieving variable content (getvar), modifying variable content (modvar), executing functions (exefnc), or storing variable content (putvar). The fifth column shows the time point of the action as specified in the Actions table. The last column shows again the name of the marker that triggers the action.

The fourth column shows the [[BrainStreamTableHandling#ActionType|type]] of action that is executed: retrieving variable content (getvar), modifying variable content (modvar), executing functions (exefnc), or storing variable content (putvar). The fifth column shows the time point of the action as specified in the Actions table. The last column shows again the name of the marker that triggers the action.

=== Data selection ===

=== Data selection ===