Difference between revisions of "Visualization with BESA Plot in FieldTrip"

From BESA® Wiki
Jump to: navigation, search
(Predefined plotting functions for data from FieldTrip)
Line 74: Line 74:
 
There are two functions available in the package <tt>MATLAB2BESA</tt> (and also in FieldTrip in the folder <tt>external\besa</tt>) which can be used to plot directly data from FieldTrip with BESA Plot. These functions are <tt>besa_plotFtSensorLevelMaps</tt> and <tt>besa_plotFtDipoleResults</tt>. The first one can be used to plot sensor level MEEG data generated by <tt>ft_timelockanalysis</tt> and the second one for dipole fit data resulted from <tt>ft_dipolefitting</tt>. The image gained with the function <tt>besa_plotFtSensorLevelMaps</tt> is shown in Figure 2 and the one generated with the function <tt>ft_dipolefitting</tt> is shown in Figure 1.
 
There are two functions available in the package <tt>MATLAB2BESA</tt> (and also in FieldTrip in the folder <tt>external\besa</tt>) which can be used to plot directly data from FieldTrip with BESA Plot. These functions are <tt>besa_plotFtSensorLevelMaps</tt> and <tt>besa_plotFtDipoleResults</tt>. The first one can be used to plot sensor level MEEG data generated by <tt>ft_timelockanalysis</tt> and the second one for dipole fit data resulted from <tt>ft_dipolefitting</tt>. The image gained with the function <tt>besa_plotFtSensorLevelMaps</tt> is shown in Figure 2 and the one generated with the function <tt>ft_dipolefitting</tt> is shown in Figure 1.
 
The functions can be called like this:
 
The functions can be called like this:
 +
<source lang="matlab">
 +
cfg = [];
 +
cfg.badchannels = 1;  % number of bad channels
 +
cfg.latency = [0.000 0.250]; % interval of interest in seconds
 +
cfg.timestep = 0.020; % time interval between two plots
 +
cfg.besaplot = '"C:\Program Files (x86)\BESA\Plot\BesaPlot.exe"'; % path to BESA Plot
 +
cfg.filebasename = 'erf1'; % basename for the generated files
 +
cfg.datapath = 'D:\Data\BesaPlot'; % folder where to save the generated files
 +
 +
status = besa_plotFtSensorLevelMaps(cfg, data_avg);
 +
</source>
 +
and
 +
<source lang="matlab">
 +
cfg = [];
 +
cfg.badchannels = 1; % number of bad channels
 +
cfg.besaplot = '"C:\Program Files (x86)\BESA\Plot\BesaPlot.exe"'; % path to BESA Plot
 +
cfg.filebasename = 'megdatafile'; % basename for the generated files
 +
cfg.datapath = 'D:\Data\BesaPlot'; % folder where to save the generated files
 +
 +
status = besa_plotFtDipoleResults(cfg, data_avg, dipole_source);
 +
</source>

Revision as of 13:18, 7 July 2016

BESA Plot is a free tool created by Patrick Berg (BESA GmbH) for visualization of MEEG data. Initially it was meant to be complementary visualization tool to BESA Research, however, it could be used in more general context. In this document we demonstrate the possibility of using BESA Plot as a visualization tool in the Matlab based open source package for MEEG data analysis FieldTrip.

Since BESA Plot can be started with command line arguments, it can be called directly from Matlab and the required input parameters (e.g. data file, settings and plotting modalities) can be committed as such arguments. There are four files necessary for starting BESA Plot from Matlab and visualizing the corresponding data: 1) a data file (e.g. test1.avr), 2) a file containing the channel labels and coordinates (e.g. test1.elp), 3) a control file containing the plotting commands for BESA Plot (e.g. test1.bpctrl) and 4) a dataset file containing general information about the data file (e.g. test1.avr.dataset). These files should be generated dynamically in Matlab in order to be able to plot the Matlab data in BESA Plot.

Generating the data file

First of all we need the data which are going to be saved as an avr-file. This is usually a Matlab structure generated in FieldTrip with the function ft_timelockanalysis. Its general form is something like this:

      avg: [147x271 double]
      var: [147x271 double]
     time: [1x271 double]
      dof: [147x271 double]
    label: {147x1 cell}
   dimord: 'chan_time'
     grad: [1x1 struct]
      cfg: [1x1 struct]

In order to create a data file from that structure one needs the function besa_save2Avr which can be found in the FieldTrip installation in the folder external\besa or can be downloaded directly from BESA’s ftp-server. Just unpack the archive and add the path to the Matlab path (e.g. addpath(‘D:\Path\to\MATLAB2BESA’)). Use the function like this:

status = besa_save2Avr(cfg.datapath, DataFile, data_matrix, ...
        time_samples, channel_labels, data_scale_factor, time_scale_factor);

Generating the channel file (*.elp)

This file contains the channel type, the channel labels and the spherical coordinates of the channels. It can be created using the function besa_save2Elp again from the package MATLAB2BESA. Use the function like this:

status = besa_save2Elp(cfg.datapath, ElpFile, ...
        SphericalCoords, channel_labels, channel_type);

Creating the BESA Plot control file

This is the actual plotting script. It follows the syntax of a scripting language defined in BESA Plot. For more details about the scripting language please refer to the program help. For this file format there is no writer function, since it can contain different scripts for different visualization scenarios. One possible script for plotting two dipoles in a schematic head could look like this:

set color=black
set size=16
set dipole number=1 xloc=0.65 yloc=0.16 zloc=0.29 xori=0.15 yori=-0.73 zori=-0.67 color=blue length=0.1 diameter=0.05
set dipole number=2 xloc=-0.65 yloc=0.16 zloc=0.29 xori=-0.17 yori=-0.57 zori=-0.81 color=blue length=0.1 diameter=0.05
head width=35 height=40 viewpoint=top brain=on x=20.0 y=75.0
head width=35 height=40 viewpoint=back brain=on x=20.0 y=30.0
head width=35 height=40 viewpoint=left brain=on x=77.0 y=77.0
set dataset=1
set mapuV=18
set mapcolor negative=blue positive=red electrode=none
set mapsize=35
set maptype=amplitude
set maplambda=1E-5
set mapviewpoint=top
set maprange maximumuV=461 minimumuV=-419 zerouV=0.0 contours=on
map latency=110.6 end=150.4 step=20 mean=on label=on x=77.0 y=30.0

The result after running the script is shown in Figure 1.

Figure 1 Dipole fitting results visualized with BESA Plot
Figure 2 Visualization of sensor level data with BESA Plot

Creating the dataset file

The dataset file contains basic information about the data in the data file. It is not essential for the visualization process, however, if it is missing, the program asks the user additional questions about the settings before generating the image. The dataset file can be created with the function besa_save2Dataset which also in the package MATLAB2BESA. Use the function like this:

status = besa_save2Dataset(DatasetPath, DataFile, ...
    ElpFile, ControlFile, NumChannels, NumTimeSamples, ...
    SamplingInterval, FirstTimeSample);

Starting BESA Plot with command line arguments

After the generation of the input files one can start BESA Plot with these files as input in order to visualize data. The syntax of the call is:

BesaPlot <data_file_name> <control_file_name>

Example:

start /b cmd /c "C:\Program Files (x86)\BESA\Plot\BesaPlot.exe" 
    M:\QM\BesaPlot\erf1.avr M:\QM\BesaPlot\erf1.bpctrl

Please note that start /b cmd /c is used to start the program in background.

Predefined plotting functions for data from FieldTrip

There are two functions available in the package MATLAB2BESA (and also in FieldTrip in the folder external\besa) which can be used to plot directly data from FieldTrip with BESA Plot. These functions are besa_plotFtSensorLevelMaps and besa_plotFtDipoleResults. The first one can be used to plot sensor level MEEG data generated by ft_timelockanalysis and the second one for dipole fit data resulted from ft_dipolefitting. The image gained with the function besa_plotFtSensorLevelMaps is shown in Figure 2 and the one generated with the function ft_dipolefitting is shown in Figure 1. The functions can be called like this:

cfg = [];
cfg.badchannels = 1;  % number of bad channels
cfg.latency = [0.000 0.250]; % interval of interest in seconds
cfg.timestep = 0.020; % time interval between two plots
cfg.besaplot = '"C:\Program Files (x86)\BESA\Plot\BesaPlot.exe"'; % path to BESA Plot
cfg.filebasename = 'erf1'; % basename for the generated files
cfg.datapath = 'D:\Data\BesaPlot'; % folder where to save the generated files
 
status = besa_plotFtSensorLevelMaps(cfg, data_avg);

and

cfg = [];
cfg.badchannels = 1; % number of bad channels
cfg.besaplot = '"C:\Program Files (x86)\BESA\Plot\BesaPlot.exe"'; % path to BESA Plot
cfg.filebasename = 'megdatafile'; % basename for the generated files
cfg.datapath = 'D:\Data\BesaPlot'; % folder where to save the generated files
 
status = besa_plotFtDipoleResults(cfg, data_avg, dipole_source);