MATLAB Interface - Revision history

Jaehyun at 12:27, 6 May 2021

2021-05-06T12:27:57Z

Mateusz at 11:35, 6 May 2021

2021-05-06T11:35:12Z

Jaehyun at 11:24, 6 May 2021

2021-05-06T11:24:51Z

Jaehyun: /* Introduction */

2021-05-06T11:23:33Z

‎Introduction

Jaehyun at 11:22, 6 May 2021

2021-05-06T11:22:47Z

Show changes

Mateusz at 19:17, 5 May 2021

2021-05-05T19:17:33Z

Mateusz at 18:51, 5 May 2021

2021-05-05T18:51:32Z

Abinash: /* How the interface works */

2021-05-04T10:42:22Z

‎How the interface works

Abinash: /* Configuration */

2021-05-04T10:41:47Z

‎Configuration

Abinash: /* Introduction */

2021-05-04T10:10:44Z

‎Introduction

@@ Line 102: / Line 102: @@
 #* Close the CMD window (there should be no error message).
 #* Sometimes if the MATLAB license is connected to a specific user account and the user account does not have administrator rights, it could be problematic to execute that command. In that case, change the corresponding account to an administrator account and then perform the actions again. After that the account could be made to regular user account again.
-#* Alternatively, you can also run the attached [ftp://h1772544.stratoserver.net/public/Matlab/BESA_Utilities/UserRegMATLAB.p UserRegMATLAB.p] function to manually register your MATLAB version as a COM Automation Server. To switch the version of MATLAB that is registered, simply run the <code>UserRegMATLAB</code> command on the new version so that it becomes the new COM Automation Server.
+#* Alternatively, you can also run the <code>UserRegMATLAB.p</code> (which can be downloaded [https://www.mathworks.com/matlabcentral/answers/uploaded_files/139006/UserRegMATLAB.p here]) function to manually register your MATLAB version as a COM Automation Server. To switch the version of MATLAB that is registered, simply run the <code>UserRegMATLAB</code> command on the new version so that it becomes the new COM Automation Server.
 #* Finally, since MATLAB 2020a to register COM server a following command can be executed directly form MATLAB: <code>comserver('register')</code>. This does not require administrator account
 # Run '''CMD (Command Prompt) as NOT administrator''', and then execute the following command <source lang="dos">matlab -automation</source> ([https://www.mathworks.com/help/matlab/matlab_external/creating-the-server-manually.html Manually create automation server]: start MATLAB as a Component Object Model (COM) Automation server. MATLAB does not display the splash screen).

@@ Line 97: / Line 97: @@
 Sometimes, the BESA to MATLAB interface stops working after installation of new/additional MATLAB version on one computer. The reason is the registry change/corruption caused by the newly installed version. In order to correct this, one has to perform the following steps:
-# Make sure that in the "'''Path'''" environment variable only the path to one MATLAB version exists.
+# Make sure that in the "'''Path'''" environment variable the path to the current MATLAB version exist and, in case of other MATLAB version are present, is first on a list.
 # Make sure that the correct MATLAB interface dll (<span style="color:#ff9c00;">BesaMatlab.dll</span> (32-bit version) or <span style="color:#ff9c00;">BesaMatlab64.dll</span> (64-bit version)) is installed by starting the tool <span style="color:#ff9c00;">ConfigureBesaMatlabInterface.exe</span> (or SetupBesaMatlabInterface.exe) and selecting the corresponding MATLAB version and architecture.
 # Run '''CMD (Command Prompt) as administrator''', and then execute the following command <source lang="dos">matlab -regserver</source> ([https://www.mathworks.com/help/matlab/matlab_external/register-matlab-as-automation-server.html registers MATLAB as a Component Object Model (COM) server]).

← Older revision		Revision as of 11:24, 6 May 2021
Line 16:		Line 16:

	'''Important: Please follow the instructions in the [[#Configuration \| Configuration]] section! Then read the [[#How the interface works \| How the interface works]] section to get started.'''		'''Important: Please follow the instructions in the [[#Configuration \| Configuration]] section! Then read the [[#How the interface works \| How the interface works]] section to get started.'''
		+

	= Configuration =		= Configuration =

@@ Line 15: / Line 15: @@
 Some MATLAB scripts that can be used in conjunction with the BESA Research MATLAB interface are also available on our website at https://www.besa.de/downloads/matlab/. You are invited to send your own scripts for data analysis or to submit any questions or feedback here: https://www.besa.de/support/support-page/.
-'''Important! Please follow the instructions in the [[#Configuration | Configuration]] section! Then read the [[#How the interface works | How the interface works]] section to get started.'''
+'''Important: Please follow the instructions in the [[#Configuration | Configuration]] section! Then read the [[#How the interface works | How the interface works]] section to get started.'''
 = Configuration =

@@ Line 9: / Line 9: @@
 == Introduction ==
-BESA Research has menu items ''"Send to MATLAB..."'' at various locations that allow to send data as structures to MATLAB. After sending the data, BESA Research starts a MATLAB script that can be used to start further data analysis on the data structure. These scripts, located in the ''Scripts\Matlab'' folder in the BESA Research installation, can be edited by the user to perform further data analysis in MATLAB. For example, if "''Send to MATLAB''" is selected in the ''File Export Dialog'', a data structure "''besa_channels''" will be created. After filling the structure, the script "''besa_action_channels.m''" will be started.
+BESA Research has menu items ''"Send to MATLAB..."'' at various locations that allow to send data as structures to MATLAB. After sending the data, BESA Research starts a MATLAB script that can be used to start further data analysis on the data structure. These scripts, located in the ''Scripts\Matlab'' folder in the BESA Research installation, can be edited by the user to perform further data analysis in MATLAB. For example, if "''Send to MATLAB''" is selected in the ''[[Export#Export Dialog|File Export Dialog]]'', a data structure "''besa_channels''" will be created. After filling the structure, the script "''besa_action_channels.m''" will be started.
-All the MATLAB export functions are batchable. Thus, a complete data analysis can be performed, in which BESA Research does the preprocessing, and passes the data on to MATLAB for a statistical analysis of the results.
+All the MATLAB export functions are batchable. Thus, a complete data analysis can be performed, in which BESA Research does the preprocessing, and passes the data on to MATLAB i.e. for a statistical analysis of the results.
-An example for the application of the MATLAB interface is demonstrated in the BESA Research Tutorial. You can download this tutorial from [https://www.besa.de/downloads/training-material/tutorials our website].
+An example for the application of the MATLAB interface is demonstrated in the BESA Research Tutorial. You can download this tutorial from [https://www.besa.de/wp-content/uploads/2021/04/BESA-Research-7.1-Tutorial.pdf our website].
 Some MATLAB scripts that can be used in conjunction with the BESA Research MATLAB interface are also available on our website at https://www.besa.de/downloads/matlab/. You are invited to send your own scripts for data analysis or to submit any questions or feedback here: https://www.besa.de/support/support-page/.
@@ Line 24: / Line 24: @@
 '''1'''. '''MATLAB must be installed.'''
 '''2'''. '''PATH environment variable:'''
@@ Line 59: / Line 57: @@
 * In the resulting dialog, enter a semicolon (;) at the end of the path string, and add the path after the semicolon.
 * In Windows 10, click the &quot;''New''&quot; button in the resulting dialog and then add the path.
+* Note that if you have multiple versions of MATLAB installed, the added path has to be prior to other MATLAB versions present in the system path.
 [[Image:Matlab (4) .gif]]
@@ Line 89: / Line 87: @@
 * Make sure that the correct MATLAB interface dll ('''BesaMatlab.dll''' (32-bit version) or '''BesaMatlab64.dll''' (64-bit version)) is installed by starting the tool '''ConfigureBesaMatlabInterface.exe''' (or SetupBesaMatlabInterface.exe) and selecting the corresponding MATLAB version and architecture.
 * Run '''CMD (Command Prompt) as administrator''', and then execute the following command (registers MATLAB as a Component Object Model (COM) server).:
 ** <code>matlab -regserver</code>
 ** Close the CMD window (there should be no error message).
 ** Sometimes if the MATLAB license is connected to a specific user account and the user account does not have administrator rights, it could be problematic to execute that command. In that case, change the corresponding account to an administrator account and then perform the actions again. After that the account could be made to regular user account again.
 * Run '''CMD (Command Prompt) as NOT administrator''', and then execute the following command (Manually create automation server: start MATLAB as a Component Object Model (COM) Automation server. MATLAB does not display the splash screen).:
 **<code>matlab -automation</code>
@@ Line 100: / Line 99: @@
 Start BESA Research and check if ''Send to MATLAB ''is displayed in the<span style="color:#3366ff;">''' File '''</span>menu. If it is, the interface is set up correctly. (Note that the item will be grayed if no file is open in BESA Research.)
-Test the interface: open a data file, mark a short (e.g. 1 s) time range, and select ''File / Send to Matlab'' to open the ''Export Dialog'':
+Test the interface: open a data file, mark a short (e.g. 1 s) time range, and select ''File / Send to Matlab'' to open the ''[[Export#Export Dialog|Export Dialog]]'':
@@ Line 148: / Line 147: @@
-Some additional scripts are used for specific data types. For example, when exporting raw data, two scripts, ''besa_helper_channels_event.m'' and ''besa_helper_channels_continuousdata.m'' are used to collect events from each data block and to combine the exported data blocks into a single matrix.
+Some additional scripts are used for specific data types. For example, when exporting raw data, two scripts, ''besa_helper_channels_event.m'' (or ''besa_helper_channels_event_continousdata.m'' for 64bit) and ''besa_helper_channels_continuousdata.m'' are used to collect events from each data block and to combine the exported data blocks into a single matrix.
 '''Command script path'''
-When the commands are executed, BESA Research automatically executes an "addpath" command in Matlab to add the ''Scripts\MATLAB'' folder (in Windows 7 typically ''C:\Users\Public\Public'' ''Documents\BESA\Research_7_1\Scripts\MATLAB'') and its first-level subfolders to the Matlab search path.
+When the commands are executed, BESA Research automatically executes an "addpath" command in Matlab to add the ''Scripts\MATLAB'' folder (in Windows 10 typically ''C:\Users\Public\Documents\BESA\Research_7_1\Scripts\MATLAB'') and its first-level subfolders to the Matlab search path.
 '''Units'''

@@ Line 2: / Line 2: @@
 |title = Module information
 |module = BESA Research Basic or higher
-|version = 6.1 or higher
+|version = BESA Research 6.1 or higher
 }}

@@ Line 21: / Line 21: @@
 == Configuration ==
-In order for the BESA-Matlab interface to work, please follow the instructions below. If you start BESA Research, and the file menu does not display the "''Send to MATLAB''" item, the interface is not installed correctly!
+In order for the BESA-MATLAB interface to work, please follow the instructions below. If you start BESA Research, and the file menu does not display the "''Send to MATLAB''" item, the interface is not installed correctly!
-'''1'''. '''Matlab must be installed.'''
+'''1'''. '''MATLAB must be installed.'''
-For step 2 (required for MATLAB versions 2009b and over), we need to know whether the 32-bit or 64-bit version of Matlab is installed. We also need to know the path to the Matlab installation (e.g. ''C:\Program'' ''Files\MATLAB\2009b\)''.
+For the next step (required for MATLAB versions 2009b and over), we need to know whether the 32-bit or 64-bit version of MATLAB is installed. We also need to know the path to the Matlab installation (e.g. ''C:\Program'' ''Files\MATLAB\2009b\)''.
 '''2'''. '''PATH environment variable:'''
-For versions 2009b and over, make sure that the path to the Win32 or Win64 folder in the Matlab installation to the PATH environment variable is defined:
+For versions 2009b and over, make sure that the path to the Win32 or Win64 folder in the MATLAB installation to the PATH environment variable is defined:
-* The path for the 64-bit version for Matlab 2009b is typically ''C:\Program'' ''Files\MATLAB\2009b\bin\win64''. For the 32-bit version, the path is typically ''C:\Program Files\MATLAB\2009b\bin\win32''.
+* The path for MATLAB 2009b:
-* Open the "System Properties" Dialog by holding down the <span style="color:#3366ff;">'''Windows'''</span> key and pressing the <span style="color:#3366ff;">'''Pause '''</span>button. In XP, the dialog is opened directly. In Vista and Window 7, the key combination opens the System Display. Click on the link "Change Settings".
+** The path for the 64-bit version for MATLAB 2009b is typically ''C:\Program'' ''Files\MATLAB\2009b\bin\win64''.
@@ Line 38: / Line 44: @@
-* Select the "Advanced" tab.
+* Select the "Advanced" tab in the &quot;''System Properties''&quot; dialog.
@@ Line 44: / Line 50: @@
-* Press the "<span style="color:#3366ff;">'''Environment Variables'''</span>" button.
+* Press the "<span style="color:#3366ff;">'''Environment Variables...'''</span>" button.
@@ Line 50: / Line 56: @@
-* Under "System variables" click on the "Path" variable and press "<span style="color:#3366ff;">'''Edit'''</span>". In the resulting dialog, enter a semicolon (;) at the end of the path string, and add the path after the semicolon.
+* Under "System variables" click on the "Path" variable and press "<span style="color:#3366ff;">'''Edit...'''</span>".
+* In the resulting dialog, enter a semicolon (;) at the end of the path string, and add the path after the semicolon.
 [[Image:Matlab (4) .gif]]
-* Press "<span style="color:#3366ff;">'''OK'''</span>" to close and save the path variable. Press "<span style="color:#3366ff;">'''OK'''</span>" to close the "System Properties" Dialog.
+* Press "''OK''" to close and save the path variable. Click "''OK''" to close the "''System Properties''" Dialog. When using Windows 7/8/10, you will also need to close the "''Control Panel''" window afterwards.
 '''3. Additional configuration''' (only required after a change of your MATLAB configuration after installation of BESA Research):
-During the installation process of BESA Research, the program "<span style="color:#ff9c00;"><span style="color:#00000a;">''SetupBesaMatlabInterface.exe''</span></span>" in the BESA Research root folder was executed. Run this program again when your MATLAB configuration has changed, e.g. after updating your MATLAB version.
+During the installation process of BESA Research, the program '''ConfigureBesaMatlabInterface.exe''' (or SetupBesaMatlabInterface'''.'''exe) in the BESA Research root folder root folder (C:\Program Files (x86)\BESA\Research_7_1) was executed.
-In the dropdown list, select the Matlab version that you are using.
+Run this program as '''administrator''' again when your MATLAB configuration has changed, e.g. after updating your MATLAB version. In the drop-down list, select the Matlab version that you are using.
 This program does two operations:
@@ Line 69: / Line 78: @@
 . it copies the appropriate interface Dll to the BESA Research root folder and renames it to "<span style="color:#ff9c00;">'''BesaMatlab.dll'''</span>" (32-bit version) or "<span style="color:#ff9c00;">'''BesaMatlab64.dll'''</span>" (64-bit version), and
-. if you are using a 64-bit version it creates an entry in <span style="color:#ff9c00;">'''BESA.ini'''</span> as follows:
+. if you are using a 64-bit version it creates an entry in '''BESA.ini''' (C:\Users\Public\Documents\BESA\Research_7_1) as follows:
-−
 [Matlab]
 Platform=64
-'''4. Testing:'''
+'''5. Testing:'''
 Start BESA Research and check if ''Send to MATLAB ''is displayed in the<span style="color:#3366ff;">''' File '''</span>menu. If it is, the interface is set up correctly. (Note that the item will be grayed if no file is open in BESA Research.)
@@ Line 86: / Line 106: @@
-The Matlab window should open, and BESA Research will display a progress bar:
+The MATLAB window should open, and BESA Research will display a progress bar:
@@ Line 92: / Line 112: @@
-After the window closes, open the Matlab window, and type "'''<code>workspace</code>'''" to open the workspace window, or "'''<code>desktop</code>'''" to open the standard Matlab desktop.
+After the window closes, open the MATLAB window, and type "'''workspace'''" to open the workspace window, or "'''desktop'''" to open the standard MATLAB desktop.
 Examine the "'''<code>besa_channels</code>'''" variable, which contains the data for the marked data segment.
@@ Line 102: / Line 122: @@
 '''Troubleshooting if the interface is not working after the above steps'''
-If the ''File / Send to MATLAB''... menu item is not shown, this means that either the path (step 2 above) is not defined properly, or that the interface Dll <span style="color:#ff9c00;">'''BesaMatlab.dll'''</span> or <span style="color:#ff9c00;">'''BesaMatlab64.dll'''</span> is not compatible with the currently installed version of Matlab.
+If the ''File / Send to MATLAB''... menu item is not shown, this means that either the path (step 2 above) is not defined properly, or that the interface Dll <span style="color:#ff9c00;">'''BesaMatlab.dll'''</span> or <span style="color:#ff9c00;">'''BesaMatlab64.dll'''</span> is not compatible with the currently installed version of MATLAB.
 If the path is correct, then please contact our support team here: https://www.besa.de/support/support-page/, including the following information:
-* Which Matlab version are you using?
+* Which MATLAB version are you using?
 * Specify also if you are using the 32-bit or 64-bit version.