User Reference:BCI2000Launcher: Difference between revisions

Latest revision as of 06:35, 19 November 2024

Introduction

The BCI2000Launcher program provides a convenient user interface for organizing BCI2000 applications and parameter files. The Source, SignalProcessing, and Application modules are selected from a list, and multiple parameter files can be loaded.

Using BCI2000Launcher

Selecting Core Modules

On the top left, a tab control displays Source, Signal Processing, and Application modules available. From there, modules may be selected by double-clicking them.

Selected modules will be displayed in the Selection pane below the tab control.

Selecting Extensions

A single click on a module in the tab control will display extensions present in that module at the top right of the window. Each extension may have one or more "enablers", i.e. command line parameters that enable functionality from that extension when present. Enablers may be selected by checking group boxes displayed to their left.

When an enabler is active, it is displayed to the right of the currently selected module in the Selection pane.

Selecting Parameter Files

A very useful feature of the BCI2000Launcher is the ability to load multiple parameter fragments. One or more fragments can be added to the list to be loaded by pressing the "+" button, and selecting the *.prm files. Files can be removed from the list using the "-" button. If more than one prm file contains the same parameter, files lower on the list will have precedence over those higher on the list.

Double-clicking a parameter file will bring up a parameter window displaying the contents of the parameter file.

Entering Recording Parameters

The SubjectName, SubjectSession, and DataDirectory parameters may be entered directly in the BCI2000Launcher dialog. These values take precedence over the parameters' values in one of the specified parameter files.

Entering Scripting Commands

In the Scripting Commands text field, you may enter Operator Scripting commands. These will be executed once all modules have been connected, and after parameter files have been loaded and recording parameters applied.

Starting a BCI2000 Session

Select the desired module from each tab by double-clicking, and click the "Launch" button in the bottom left corner.

@@ Line 1: / Line 1: @@
-<!-- TODO
-Adapt the description to the v3 launcher program.
--->
 ==Introduction==
-The BCI2000Launcher program provides a convenient user interface for organizing BCI2000 applications and parameter files. The Source, SignalProcessing, Application, and Operator modules are selected from a list, multiple parameter files can be loaded, and all are launched simultaneously, replacing the need for multiple batch files.
+The BCI2000Launcher program provides a convenient user interface for organizing BCI2000 applications and parameter files. The Source, SignalProcessing, and Application modules are selected from a list, and multiple parameter files can be loaded.
 [[Image:BCI2000Launcher.png]]
 ==Using BCI2000Launcher==
-===Organizing BCI2000 Modules===
+===Selecting Core Modules===
-On the first launch, BCI2000Launcher examines the contents of the BCI2000.v2.0/prog/ folder, looking for executable programs. Known programs are sorted appropriately, e.g., the gUSBampSource.exe program is placed in "Acquisition" column. If a program is not recognized, it is placed in the "Others" column. Right-clicking on a module brings up a context menu that allows it to be moved to another column. Programs that are rarely used can be moved to the "Others" column to keep them out of the way. Finally, programs that are used often can be dragged to the top of a list, and it will be automatically selected when BCI2000Launcher starts. All settings are kept in the BCIlauncher.ini file, which is stored in the BCI2000.v2.0/prog/ folder. If this file is removed or missing, it will be automatically regenerated, and the modules will have to be reorganized manually.
+On the top left, a tab control displays Source, Signal Processing, and Application modules available.
+From there, [[Technical_Reference:System_Design|modules]] may be selected by double-clicking them.
+Selected modules will be displayed in the ''Selection'' pane below the tab control.
+===Selecting Extensions===
+A single click on a module in the tab control will display [[Contributions:Extensions|extensions present]] in that module at the top right of the window.
+Each extension may have one or more "enablers", i.e. command line parameters that enable functionality from that extension when present.
+Enablers may be selected by checking group boxes displayed to their left.
+When an enabler is active, it is displayed to the right of the currently selected module in the ''Selection'' pane.
 ===Selecting Parameter Files===
-A very useful feature of the BCI2000Launcher is the ability to load multiple parameter fragments. One or more fragments can be added to the list to be loaded by pressing the "..." button, and selecting the *.prm files. Files can be removed from the list using the "X" button. If more than one prm file contains the same parameter, files lower on the list will have precedence over those higher on the list.
+A very useful feature of the BCI2000Launcher is the ability to load multiple [[Technical_Reference:Parameter_File|parameter fragments]]. One or more fragments can be added to the list to be loaded by pressing the "+" button, and selecting the *.prm files. Files can be removed from the list using the "-" button. If more than one prm file contains the same parameter, files lower on the list will have precedence over those higher on the list.
+Double-clicking a parameter file will bring up a parameter window displaying the contents of the parameter file.
+===Entering Recording Parameters===
+The [[User_Reference:DataIOFilter#SubjectName|SubjectName]], [[User_Reference:DataIOFilter#SubjectSession|SubjectSession]], and [[User_Reference:DataIOFilter#DataDirectory|DataDirectory]] parameters may be entered directly in the BCI2000Launcher dialog. These values take precedence over the parameters' values in one of the specified parameter files.
+===Entering Scripting Commands===
+In the ''Scripting Commands'' text field, you may enter [[User_Reference:Operator_Module_Scripting|Operator Scripting]] commands.
+These will be executed once all modules have been connected, and after parameter files have been loaded and recording parameters applied.
 ===Starting a BCI2000 Session===
-Select the desired modules from each column. You can also select multiple programs to be started from the "Others" column at the same time. Additionally, you can deselect modules by pressing the "Clear All" button, and select individual programs to launch and connect to the Operator, without start all required modules. This is useful for debugging new programs, since the new program can connect from a debugging session, and the others will start as normal.
+Select the desired module from each tab by double-clicking, and click the "Launch" button in the bottom left corner.
 [[Category:User Interface]]