Difference between revisions of "AnyWave:ICA"

From WikiMEG
Jump to: navigation, search
(Batch mode)
(Batch mode)
Line 37: Line 37:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
keys documentation:<br/>
+
{| class="wikitable"
* plugin = the plugin name ('''MANDATORY''')
+
|-
* hp,lp : high pass, low pass filters ('''OPTIONAL''')
+
! key !! description !! requirement !! default behavior
* downsampling : enable or disable the downsampling of data before computation. ('''OPTIONAL''')
+
|-
* comp : the number of expected independent components ('''OPTIONAL''')
+
| plugin || Name of plugin || MANDATORY || n/a
* input_file : the data file ('''MANDATORY''', can also speficied as a command line option).
+
|-
* output_dir : the folder where to write the result file ('''OPTIONAL''' can also be specified as a command line).
+
| lp, hp || low pass, high pass filters || OPTIONAL || if not specifed, no data filtering.
* use_markers : array of markers to use to select the data. ('''OPTIONAL''')
+
|-
* skip_markers : array of markers to AVOID ('''OPTIONAL''').
+
| downsampling || enable/disable downsampling of data || OPTIONAL || default is true
 +
|-
 +
| modality || channel modality (MEG, EEG, ...) || MANDATORY || n/a
 +
|}

Revision as of 10:35, 12 June 2019

ICA Plug-in

This plugin will extract Independent Components from signals.
The algorithm used is the Infomax algorithm.
This plug-in will run in the background, doing the computation and then a file will be created containing the resulting matrices: (mixing and unmixing matrices).
The only user interface is the one which let the user set all the settings before the computation is done.

ICA ui.png

Algorithm

The plug-in was designed to implement several algorithms but only infomax is implemented so far.

Filtering

The user can specify a frequency bandwidth to use by defining a low pass and a high pass filtering.
Note that decimation will be applied depending on the low pass filtering, to shorten the calculation time and minimize the memory usage.

Data Input

The user must choose on what type of signal the computation will be done (EEG or MEG).
By default, bad channels are excluded. Finally, markers can be used to remove bad part of the signals (artifacts, etc.), the user must first add markers by itself or using another plug-in with an explicit name.

Data Output

The number of components is by default limited to 50 but all the components can be extracted at the cost of a longer calculation.
By default, a result file will be created in the data folder. This file can be imported afterward in AnyWave by using the Load ICA Components feature.

Batch mode

This plugin can run in command line or batch mode.
Here are the json keys the plugin will use:

{
"plugin": "ica", 
"hp": 1,
"lp": 45,
"comp" : 50,
"downsampling" : false,
"modality" : "MEG",
"input_file" : "/path/to/data.meg",
"output_dir" : "/path/to/output_dir",
"use_markers" : [ "selection1", "selection2"],
"skip_markers" : [ "artefact", "artefacted" ]
}
key description requirement default behavior
plugin Name of plugin MANDATORY n/a
lp, hp low pass, high pass filters OPTIONAL if not specifed, no data filtering.
downsampling enable/disable downsampling of data OPTIONAL default is true
modality channel modality (MEG, EEG, ...) MANDATORY n/a