User Reference:Operator Notes
Overview
Often it is desirable to take informal notes during a recording. BCI2000 allows to do so by providing
- an Operator window for text entry,
- a defined format for saving notes with recorded data,
- support for displaying and navigating recorded notes in the BCI2000Viewer tool.
Taking Notes during recording in Operator
The Notes window consists of a status message at the top, followed with a message view in the center, and an edit field for entering messages at the bottom.
When opening the Notes window while BCI2000 is idle or suspended, it will display a status message in red, saying than notes will not be saved. Still, it will allow for entering messages, which will appear in grey within the message view.
During a BCI2000 run (i.e., while a recording takes place), the status message will be green, and messages will appear in black when moving into the message view.
Whenever the user presses "Enter", the current message will be moved to the message view and displayed with a timestamp. Also, it will be written to a notes file that is saved along with the data file. At the same time, the Notes event will be set to the ordinal number (1-based number) of the note being saved.
Note storage and file format
Notes are stored in text files, located at the same directory as a run's output file. Their naming is the same as for data files, except that the infix _notes appears before the extension, and the extension is .txt.
Thus, notes files are named as in the following examples:
name001R02.dat name001R02_notes.txt name001R02.part2.dat name001R02_notes.part2.txt
In the notes file, each line is terminated with CRLF, and corresponds to a single note. Also, each line begins with to time stamps, separated by tab characters:
- an absolute timestamp in ISO 8601 extended format, and
- a relative timestamp since the beginning of the associated data file, in hours:minutes:seconds format.
For example:
2024-02-15T18:33:52 0:00:04 Foo 2024-02-15T18:33:54 0:00:07 Bar 2024-02-15T18:33:57 0:00:10 Baz 2024-02-15T18:34:00 0:00:12 Foobar 2024-02-15T18:34:08 0:00:20 Baz in foo 2024-02-15T18:34:15 0:00:28 Bar with baz 2024-02-15T18:34:30 0:00:43 Foobar
Viewing Notes in BCI2000Viewer
BCI2000Viewer uses the Notes event present in the file in order to associate notes with data. At the beginning of a file, the Notes event is set to 0, indicating that no note is present. As soon as the first note is entered, the Notes event goes to 1, indicating that note 1 has been entered at the moment of the change. The notes event will then stay at 1, until note 2 is entered.
Whenever a note is clicked in the notes view at the left of the window, BCI2000Viewer will seek the main file such that the switch to the note's number in the Notes state will be located at the right edge of the window. This is because typically there is an (unknown) delay between the event described in the note, and entering of the note, but in any case the event occurred prior to entering the note.
While playing back or navigating a data file, notes will be highlighted in grey as determined by the Notes event.
See also
User Reference:Operator Module, User Reference:BCI2000Viewer