Control of BESA Research by external programs - Revision history

Robert: /* Examples */

2021-05-05T07:26:52Z

‎Examples

Robert: /* Start BESA Research to open EEG data */

2021-05-05T07:25:55Z

‎Start BESA Research to open EEG data

Robert at 07:24, 5 May 2021

2021-05-05T07:24:50Z

Abinash at 15:40, 15 February 2017

2017-02-15T15:40:09Z

Harald at 09:01, 11 April 2016

2016-04-11T09:01:56Z

Andre: Andre moved page Control BESA Research by external programs to Control of BESA Research by external programs without leaving a redirect: bad english?

2016-04-08T11:30:30Z

Andre moved page Control BESA Research by external programs to Control of BESA Research by external programs without leaving a redirect: bad english?

Andre: Control OF BESA ....

2016-04-08T11:28:04Z

Control OF BESA ....

Andre: /* Purpose and Procedure */ minor change

2016-04-08T10:03:34Z

‎Purpose and Procedure: minor change

Andre: fixed some section links

2016-04-08T09:59:20Z

fixed some section links

Andre: migrated existing description to wiki

2016-04-08T09:40:31Z

migrated existing description to wiki

New page

=Control BESA Research by external programs (valid for BESA Research versions 5.2.2 and higher)=

==Purpose and Procedure==
This document describes how to start BESA Research from an external program (a patient database management program or an EEG review program) with a list of one or more files to be opened in BESA Research. It is recommended to create an icon BESA or BESA Research in the external program and to start BESA Research using this icon.
* To start BESA Research from the external program to review EEG data, this program must first write the foc_link.sub file to disk. It must contain the data file(s) to be opened (see Chapter 4). Then BESA Research needs to be started as described below in Chapter 2.
* If BESA Research is already running, first the file foc_link.sub has to be updated or created.
* If the foc_link.sub file is written to the BESA Research installation folder, BESA Research can either be accessed by executing a WM_COMMAND (see Chapter 3) or using the procedure described in Chapter 2.
* If the foc_link.sub file is written to another folder, only the procedure described in Chapter 2 can be used.
We recommend using the procedure described in Chapter 2 in all cases, since this will work in all cases, and the foc_link.sub file can be located in any arbitrary folder.

==Start BESA Research to open EEG data==
Use the following command to start BESA Research with the command line parameter:
<foc_link.sub file path>\foc_link.sub
The foc_link.sub file contains a list of the datasets to be loaded at program start. The file format is described below in Chapter 4.
For example, to load EEGs in BESA 5.2.2 or higher (e.g. BESA Research 5.3) at program start (assumed to be installed in C:\BESA52 and file foc_link.sub file located in the BESA Research installation folder), apply the following command:

C:\BESA52\BESA.exe C:\BESA52\foc_link.sub
==Open EEG data while BESA Research is running==
If you want to load a different EEG data file while BESA Research is running, simply execute the same command as upon start of BESA Research after updating the file list in foc_link.sub, e.g.
C:\BESA52\BESA.exe C:\BESA52\foc_link.sub
BESA.exe interprets this call from a database or review program. It checks whether BesaMain.exe is already running. If yes, it keeps BesaMain.exe running, closes the old files, and opens the new file(s) listed in foc_link.sub. If not yet running, BESA.exe starts BesaMain.exe with the new file(s) listed in foc_link.sub. Thus, the procedure for changing an EEG file in BESA Research is the same as described in Chapter 2 for starting BESA Research with the first file(s).

( In older BESA versions (up to version 5.2) a different procedure was required that is still working but not required anymore:
When BESA receives a WM_COMMAND message with Id 3000 (Id = (int)(LOWORD(wParam)), file foc_link.sub in the BESA installation folder was reread. While this feature is still working, it is not recommended anymore because the automatic handling by BESA.exe is much simpler and no WM_COMMAND message is needed. )
Notes:
* Files that are currently open but not specified in foc_link.sub are closed. Only the specified files are opened.
* When a file is closed in BESA Research, the corresponding entry in the foc_link.sub file is deleted.
* Format of foc_link.sub
For each EEG to be loaded write the following lines to the foc_link.sub file
StartedBy: <Your program name>
EvtFilePath: <path + filename of the evt-File to be loaded for the EEG>
EventCode: [<number>] <number> <number>
ElecFilePath: <path + filename of the elp-File to be loaded for the EEG>
ReviewDateTime: <YYYY-MM-DD/HH:MM:SS>
FilePath: <path + filename of EEG to be loaded>

The first line, StartedBy (followed by a colon and a blank), is an optional tag that can be set to specify the name of your application which calls BESA Research.
The second line, EvtFilePath (followed by a colon and a blank), is an optional tag that can be set to load events specified in an evt-file. If this tag is not defined, only the events found in the EEG data file are loaded.
The third line, EventCode (followed by a colon and a blank), is an optional tag that can be set to define the type and range of your events stored in the event file specified in EvtFilePath.
The first number defines the code (type) of your events (e.g. 1=Trigger). The second number defines the event ID range minimum and the third number stands for the maximum.
If this tag is defined, BESA Research will remove all events from the EEG which IDs are within the defined range. Then the new events are loaded instead. If this tag is not defined, the new events are loaded in addition to existing events. This tag will be ignored if no EvtFilePath is defined.
The fourth line, ElecFilePath (followed by a colon and a blank), is an optional tag that can be set to attach an electrode configuration specified in an elp-file. If this tag is not defined, the original/recorded electrode configuration found in the EEG-Data file is loaded.
The fifth line, ReviewDateTime (followed by a colon and a blank), is an optional tag that can be set to specify a time at which the review should be started. If this tag is not defined, the review starts at the beginning of the file.
The FilePath line must be the last line for each EEG entry and has to be defined. The tag is followed by path+filename (after the obligatory colon and blank). A maximum of 256 characters for path+filename is read.

==Examples==
===Open one EEG data file at the beginning.===

FilePath: D:\EEG\000822WC.eeg

===Open one EEG data file at a defined position.===

ReviewDateTime: 2008-07-02/12:18:12
FilePath: D:\EEG\000822WC.eeg

===Open three EEG data files, position for second data file is specified.===

FilePath: D:\EEG\000822WC.eeg

ReviewDateTime: 2008-07-02/12:18:12
FilePath: D:\EEG\000822WD.eeg

FilePath: D:\EEG\000822WE.eeg

We suggest to separate single EEG entries by an empty line, although this is not required.
===Complete foc_link.sub entry with all possible tags===

StartedBy: BESA Epilepsy
ElecFilePath: C:\ELP-FILES\000717WA-STD.elp
EvtFilePath: C:\EVT-FILES\000717WA-STD.evt
EventCode: 1 51 60
ReviewDateTime: 2008-07-02/14:20:12
FilePath: D:\EEG\000717WA.eeg

[[Category:BESA Research]]

← Older revision		Revision as of 15:40, 15 February 2017
Line 81:		Line 81:


−	[[Category:~~BESA Research~~]]	+	[[Category:Setup]]

← Older revision		Revision as of 09:01, 11 April 2016
Line 1:		Line 1:
−	=~~Control of~~ BESA Research ~~by external programs (valid for BESA Research versions~~ 5.2.2 ~~and~~ higher)=	+	{{BESAInfobox
		+	\|title = Module information
		+	\|module = BESA Research Basic or higher
		+	\|version = 5.2.2 or higher
		+	}}
		+
		+	=Control of BESA Research by external programs=

	==Purpose and Procedure==		==Purpose and Procedure==

← Older revision		Revision as of 11:28, 8 April 2016
Line 1:		Line 1:
−	=Control BESA Research by external programs (valid for BESA Research versions 5.2.2 and higher)=	+	=Control of BESA Research by external programs (valid for BESA Research versions 5.2.2 and higher)=

	==Purpose and Procedure==		==Purpose and Procedure==

@@ Line 7: / Line 7: @@
 * If the foc_link.sub file is written to the BESA Research installation folder, BESA Research can either be accessed by executing a WM_COMMAND (see [[#Open EEG data while BESA Research is running|Open EEG data while BESA Research is running]]) or using the procedure described in [[#Start BESA Research to open EEG data|Start BESA Research to open EEG data]].
 * If the foc_link.sub file is written to another folder, only the procedure described in [[#Start BESA Research to open EEG data|Start BESA Research to open EEG data]] can be used.
-We recommend using the procedure described in [[#Start BESA Research to open EEG data|Start BESA Research to open EEG data]] in all cases, since this will work in all cases, and the foc_link.sub file can be located in any arbitrary folder.
+We recommend using the procedure described in [[#Start BESA Research to open EEG data|Start BESA Research to open EEG data]], since this will work in all cases, and the foc_link.sub file can be located in any arbitrary folder.
 ==Start BESA Research to open EEG data==

@@ Line 60: / Line 60: @@
 ===Open one EEG data file at the beginning.===
 FilePath: D:\EEG\000822WC.eeg
 ===Open one EEG data file at a defined position.===
 ReviewDateTime: 2008-07-02/12:18:12
 FilePath: D:\EEG\000822WC.eeg
 ===Open three EEG data files, position for second data file is specified.===
 FilePath: D:\EEG\000822WC.eeg
@@ Line 75: / Line 80: @@
 FilePath: D:\EEG\000822WE.eeg
 We suggest to separate single EEG entries by an empty line, although this is not required.
@@ Line 80: / Line 86: @@
 ===Complete foc_link.sub entry with all possible tags===
 StartedBy: BESA Epilepsy
 ElecFilePath: C:\ELP-FILES\000717WA-STD.elp
@@ Line 86: / Line 93: @@
 ReviewDateTime: 2008-07-02/14:20:12
 FilePath: D:\EEG\000717WA.eeg
+</source >
 [[Category:Setup]]

@@ Line 21: / Line 21: @@
 For example, to load EEGs in BESA 5.2.2 or higher (e.g. BESA Research 5.3) at program start (assumed to be installed in C:\BESA52 and file foc_link.sub file located in the BESA Research installation folder), apply the following command:
 C:\BESA52\BESA.exe C:\BESA52\foc_link.sub
 ==Open EEG data while BESA Research is running==

@@ Line 4: / Line 4: @@
 |version = 5.2.2 or higher
 }}
 ==Purpose and Procedure==
 This document describes how to start BESA Research from an external program (a patient database management program or an EEG review program) with a list of one or more files to be opened in BESA Research. It is recommended to create an icon BESA or BESA Research in the external program and to start BESA Research using this icon.
 * To start BESA Research from the external program to review EEG data, this program must first write the foc_link.sub file to disk. It must contain the data file(s) to be opened (see [[#Format of foc_link.sub|Format of foc_link.sub]]). Then BESA Research needs to be started as described below in [[#Start BESA Research to open EEG data|Start BESA Research to open EEG data]].
@@ Line 16: / Line 15: @@
 ==Start BESA Research to open EEG data==
 Use the following command to start BESA Research with the command line parameter:
 <foc_link.sub file path>\foc_link.sub
@@ Line 22: / Line 22: @@
 C:\BESA52\BESA.exe C:\BESA52\foc_link.sub
 ==Open EEG data while BESA Research is running==
 If you want to load a different EEG data file while BESA Research is running, simply execute the same command as upon start of BESA Research after updating the file list in foc_link.sub, e.g.
 C:\BESA52\BESA.exe C:\BESA52\foc_link.sub
@@ Line 32: / Line 34: @@
 * Files that are currently open but not specified in foc_link.sub are closed. Only the specified files are opened.
 * When a file is closed in BESA Research, the corresponding entry in the foc_link.sub file is deleted.
 ==Format of foc_link.sub==
 For each EEG to be loaded write the following lines to the foc_link.sub file
 StartedBy: 		<Your program name>
@@ Line 51: / Line 55: @@
 ==Examples==
 ===Open one EEG data file at the beginning.===
@@ Line 70: / Line 75: @@
 We suggest to separate single EEG entries by an empty line, although this is not required.
 ===Complete foc_link.sub entry with all possible tags===

← Older revision	Revision as of 11:30, 8 April 2016
(No difference)