1,658
edits
Changes
Jump to navigation
Jump to search
Line 3:
Line 3: − + − + − + Line 36:
Line 36: − + − + Line 57:
Line 57: − + Line 66:
Line 66: − + Line 72:
Line 72: − + − + − +
BrainStreamBrainStreamEditor (view source)
Revision as of 15:25, 21 September 2018
, 15:25, 21 September 2018no edit summary
__TOC__
__TOC__
BrainStream's internal editor can be used to create and test [[DocsSectionsBuildingExperiments#SecProjectFile|BrainStream projects]]. The editor shows the [[DocsSectionsBuildingExperiments#SecExpDef|experiment definition tables]], [[DocsSectionsBuildingExperiments#SecBlock|block files and common block files]] associated with a project. Changes can be made to any of the files directly from the editor.
BrainStream's internal editor can be used to create and test [[BrainStreamBuildingExperiments#SecProjectFile|BrainStream projects]]. The editor shows the [[BrainStreamBuildingExperiments#SecExpDef|experiment definition tables]], [[BrainStreamBuildingExperiments#SecBlock|block files and common block files]] associated with a project. Changes can be made to any of the files directly from the editor.
== Opening the BrainStream Editor ==
== Opening the BrainStream Editor ==
The BrainStream editor can be opened from Matlab with the command <tt>bs_editor</tt> (make sure that <tt>brainstream_mds/core</tt> is your current working directory). A popup window appears enabling you to load a saved [[DocsSectionsBuildingExperiments#SecProjectFile|BrainStream project]] (.bsp or .exp) from disk. It is recommended not to click any buttons while a project is being loaded. Pressing the Cancel button allows you to choose from a list of recently opened experiment files. If the Cancel button is pressed again, a new project is opened.
The BrainStream editor can be opened from Matlab with the command <tt>bs_editor</tt> (make sure that <tt>brainstream_mds/core</tt> is your current working directory). A popup window appears enabling you to load a saved [[BrainStreamBuildingExperiments#SecProjectFile|BrainStream project]] (.bsp or .exp) from disk. It is recommended not to click any buttons while a project is being loaded. Pressing the Cancel button allows you to choose from a list of recently opened experiment files. If the Cancel button is pressed again, a new project is opened.
Projects can be created, opened and closed via the Projects menu on the menu bar. Clicking on the Windows menu shows a list of all projects that are opened in the BrainStream editor. The currently shown project is indicated with a check mark.
Projects can be created, opened and closed via the Projects menu on the menu bar. Clicking on the Windows menu shows a list of all projects that are opened in the BrainStream editor. The currently shown project is indicated with a check mark.
Experiment definition tables are not automatically loaded at startup, because loading tables that you do not want to view takes up unnecessary time. Instead, you can load the tables that you want to view by clicking on them in the Tables section (section number 1, see [[#BSedTables|below]]). If you want to load a table and all the tables it refers to (see [[DocsSectionsPlugIns|Import-tables]]), you can place a check mark in the box 'Load referenced tables' above the Tables section.
Experiment definition tables are not automatically loaded at startup, because loading tables that you do not want to view takes up unnecessary time. Instead, you can load the tables that you want to view by clicking on them in the Tables section (section number 1, see [[#BSedTables|below]]). If you want to load a table and all the tables it refers to (see [[BrainStreamPlugIns|Import-tables]]), you can place a check mark in the box 'Load referenced tables' above the Tables section.
<div id="BSedGUI"></div>
<div id="BSedGUI"></div>
If one cell is selected, its content will be shown in the grey area under the table. This is useful for cells that contain a lot of text. The content of the cell can be edited either in this grey area or in the cell itself.
If one cell is selected, its content will be shown in the grey area under the table. This is useful for cells that contain a lot of text. The content of the cell can be edited either in this grey area or in the cell itself.
The ‘Expand table’ option opens a window showing one table with the combined data from all tables. The [[DocsSectionsPlugIns#TableExpansion|expanded table]] shows the final sequence of actions, the combined marker dictionary and the data selection settings.
The ‘Expand table’ option opens a window showing one table with the combined data from all tables. The [[BrainStreamPlugIns#TableExpansion|expanded table]] shows the final sequence of actions, the combined marker dictionary and the data selection settings.
More information about the structure of experiment definition tables can be found [[DocsSectionsBuildingExperiments#SecExpDef|here]].
More information about the structure of experiment definition tables can be found [[BrainStreamBuildingExperiments#SecExpDef|here]].
<div id="BSedBlockFiles"></div>
<div id="BSedBlockFiles"></div>
When a (common) block file is selected in section 3 or 4, the content of this file is shown here. The blue bar above section 5 shows the name of the selected block file and whether it is a block file or a common block file. Any changes to the block file made here will be incorporated in the next brainstream test run, but they will not be saved automatically. In order to save the changes, click the ‘save block’ or ‘save common block’ button on the right, or left click on the file in area 3 or 4 while holding the Ctrl key and select ‘save blockfile’.
When a (common) block file is selected in section 3 or 4, the content of this file is shown here. The blue bar above section 5 shows the name of the selected block file and whether it is a block file or a common block file. Any changes to the block file made here will be incorporated in the next brainstream test run, but they will not be saved automatically. In order to save the changes, click the ‘save block’ or ‘save common block’ button on the right, or left click on the file in area 3 or 4 while holding the Ctrl key and select ‘save blockfile’.
More information about the structure of (common) block files can be found [[DocsSectionsBuildingExperiments#SecBlock|here]].
More information about the structure of (common) block files can be found [[BrainStreamBuildingExperiments#SecBlock|here]].
=== 6. Combined current block file and common block files ===
=== 6. Combined current block file and common block files ===
In order to test your experiment, press the Test brainstream button in the top left corner. Remember that unsaved changes to the block files and common block files are incorporated in the test run, whereas unsaved changes to the experiment definition tables are ignored.
In order to test your experiment, press the Test brainstream button in the top left corner. Remember that unsaved changes to the block files and common block files are incorporated in the test run, whereas unsaved changes to the experiment definition tables are ignored.
If you should want to stop you experiment while it is running, you can click the Exit block or Quit block button in the top left corner. Doing so will insert the [[DocsSectionsReservedNames#ResMarkers|BS_EXIT]] or [[DocsSectionsReservedNames#ResMarkers|BS_QUIT]] marker, respectively. Alternatively, you can insert these markers manually (click [.DocsSectionsRunningExperiments#InsertMarkers here] for more information).
If you should want to stop you experiment while it is running, you can click the Exit block or Quit block button in the top left corner. Doing so will insert the [[DocsSectionsReservedNames#ResMarkers|BS_EXIT]] or [[BrainStreamReservedNames#ResMarkers|BS_QUIT]] marker, respectively. Alternatively, you can insert these markers manually (click [[BrainStreamRunningExperiments#InsertMarkers|here]] for more information).
== Keyboard shortcuts ==
== Keyboard shortcuts ==
Ctrl+O can be used in the Experiment Definition table section of the BrainStream editor. This has different effects depending on what kind of cell is selected in the table:
Ctrl+O can be used in the Experiment Definition table section of the BrainStream editor. This has different effects depending on what kind of cell is selected in the table:
* selected cell contains a [[DocsSectionsBuildingExperiments#SecUserFun|user defined function]]: Ctrl+O opens this function in the Matlab editor
* selected cell contains a [[BrainStreamBuildingExperiments#SecUserFun|user defined function]]: Ctrl+O opens this function in the Matlab editor
* selected cell contains the name of a [[DocsSectionsParallelMode#SecClients|client]]: Ctrl+O shows this client's IP address
* selected cell contains the name of a [[BrainStreamParallelMode#SecClients|client]]: Ctrl+O shows this client's IP address
* selected cell contains a reference to a [[DocsSectionsPlugIns|import-table]] ('@import_table'): Ctrl+O opens the referenced table
* selected cell contains a reference to a [[BrainStreamPlugIns|import-table]] ('@import_table'): Ctrl+O opens the referenced table
<!---End1--->
<!---End1--->