Difference between revisions of "AnyWave:H2"
(→Batch mode) |
|||
Line 1: | Line 1: | ||
=Purpose and usage= | =Purpose and usage= | ||
The plugin computes the connectivity between channels using h2/r2 algorithms.<br/> | The plugin computes the connectivity between channels using h2/r2 algorithms.<br/> | ||
− | == | + | ==How to run the plugin== |
+ | There are two ways to run the plugin:<br/> | ||
+ | * Running using the Processes menu of AnyWave. | ||
+ | * Running user the markers GUI. | ||
+ | |||
The first step is to select the channels of interest.<br/> | The first step is to select the channels of interest.<br/> | ||
If there is no selection when launching the plugin, a warning message will pop saying that all channels will be used for the computation.<br/> | If there is no selection when launching the plugin, a warning message will pop saying that all channels will be used for the computation.<br/> |
Revision as of 14:24, 8 August 2019
Contents
Purpose and usage
The plugin computes the connectivity between channels using h2/r2 algorithms.
How to run the plugin
There are two ways to run the plugin:
- Running using the Processes menu of AnyWave.
- Running user the markers GUI.
The first step is to select the channels of interest.
If there is no selection when launching the plugin, a warning message will pop saying that all channels will be used for the computation.
Select sections of data
Insert markers on the data of interest using the Marking tool of AnyWave or used previous marked data.
To launch the plugin on a specific markers selection, use the markers list on the left side of the signal view:
- select the markers of interest in the lis.
- right click and choose Launc Process
- Pick the H2 process and launch.
Computation parameters
Data input
To speed up the computation you may want to downsampling the data. The default is to NOT downsample the data (x1).
If you have marked data, you can specify which artefacted parts of the data to avoid in computation using the skip data using markers options:
- select the marker corresponding to the part to skip (ie 'artefact').
- click Skip button to add it to the list of markers to skip.
In the same way, you can also specify on which particular marked data compute the connectivity:
- select the marker corresponding to a period of interest.
- click the Use button to add it to the list of markers to use for computation.
Frequency bands
You can compute the connectivity on different frequency bands.
By default, the AnyWave band is selected which means the filter options set in AnyWave will be used.
You can enable the different predefined bands and even change the frequency boundaries.
Review resulting graphs
When the computation is finished, the resuslts are saved to a MATLAB file located in the data file's folder.
Another plugin is automatically launched allowing you to browse the different connectivy graphs:
The UI propose all the graphs resulting from the computation. A graph for each frequency band.
You can see what algorihtm was used on what frequency band and the number of sections which is the number of selected part of data used for computation.
Click on rows to select them and click on View to see the graphs.
Batch mode
The plugin is able to run in batch mode.
See this section for more details
json settings for h2/r2:
{ "plugin" : "h2", "algorithm" : "r2", "time_window" : 4, "max_lag" : 0.1, "step" : 1, "downsampling_factor" : 2, "output_prefix" : "my_result" }
Common options that can also be specified in the command line if you want to apply them to a specific file and not ALL the files:
key | description | default behavior |
---|---|---|
marker_file | path to the .mrk file to use | if not specified, AnyWave will try to locate the .mrk associated with the data file and use it. |
use_markers | array of marker labels to use | optional but may required marker_file option. |
skip_markers | array of marker labels to SKIP (artefacts) | optional but may required marker_file option. |
hp | high pass filter in Hz | optional |
lp | low pass filter in Hz | optional |
H2 specific options:
key | description | requirement | default behavior |
---|---|---|---|
plugin | Name of plugin | MANDATORY | n/a |
time_window | the time window in s. | MANDATORY | n/a |
max_lag | maximum lag in s. | MANDATORY | n/a |
step | step in s. | MANDATORY | n/a |
downsampling_factor | downsampling data | OPTIONAL | default is 1. 2 means the sampling rate of the data will be divided by 2. |
output_prefix | prefix of resulting file name | OPTIONAL | default is no prefix. |
Example
using this json file:
{ "plugin" : "h2", "algorithm" : "r2", "time_window" : 4, "max_lag" : 0.1, "step" : 1, "downsampling_factor" : 2, "output_prefix" : "my_result", "use_markers" : [ "EI" ] }
We will compute on a file stored in D:\Data\
anywave --run h2.json --input_file d:\data\data_file.eeg --marker_file d:\data\data_file.mrk --hp 1 --lp 45
This will compute compute r2 values for the file data_file.eeg using 1-45Hz frequency band only on data marked by a EI marker.