Difference between revisions of "AnyWave:CLI H2"
From WikiMEG
OHAGeraldo (Talk | contribs) (Created page with "Cathi is actually the nick name people implement to call us me although it is not some of the name on your my rise certificate. What he really enjoys undertaking is finishing...") |
(Created page with "=Arguments description for plugin H2= plugin name: '''h2'''<br/> {| ! style="text-align:left;"| argument ! requirement ! description |- |input_file <file> |'''MANDATORY''' ...") |
||
Line 1: | Line 1: | ||
− | + | =Arguments description for plugin H2= | |
+ | plugin name: '''h2'''<br/> | ||
+ | |||
+ | {| | ||
+ | ! style="text-align:left;"| argument | ||
+ | ! requirement | ||
+ | ! description | ||
+ | |- | ||
+ | |input_file <file> | ||
+ | |'''MANDATORY''' | ||
+ | |common argument | ||
+ | |- | ||
+ | |time_window <value> | ||
+ | |'''MANDATORY''' | ||
+ | |time window in seconds. | ||
+ | |- | ||
+ | |step <value> | ||
+ | |'''MANDATORY''' | ||
+ | |step in seconds. | ||
+ | |- | ||
+ | |max_lag <value> | ||
+ | |'''MANDATORY''' | ||
+ | |maximum lag in seconds. | ||
+ | |- | ||
+ | |hp <value> | ||
+ | | OPTIONAL | ||
+ | |common hp argument. | ||
+ | |- | ||
+ | |lp <value> | ||
+ | | OPTIONAL | ||
+ | |common lp argument. | ||
+ | |- | ||
+ | |- | ||
+ | |algorithm <r2,h2> | ||
+ | |OPTIONAL | ||
+ | |algorithm method to compute correlation. Default is h2. | ||
+ | |- | ||
+ | |downsampling <flag> | ||
+ | | OPTIONAL | ||
+ | |Downsampling data before computing. Default is false | ||
+ | |- | ||
+ | |infomax_extended <flag> | ||
+ | |OPTIONAL | ||
+ | |Use the extended option for Infomax. Default is false. | ||
+ | |- | ||
+ | |skip_bad <flag> | ||
+ | |OPTIONAL | ||
+ | |Skip bad channels. Default is true. | ||
+ | |- | ||
+ | |skip_markers <marker name> | ||
+ | |OPTIONAL | ||
+ | |common argument. ICA will skip all the data sections marked by the specified marker. | ||
+ | |- | ||
+ | |use_markers <marker name> | ||
+ | |OPTIONAL | ||
+ | |common argument. ICA will only compute on data sections marked by the specified marker. | ||
+ | |- | ||
+ | |output_dir <dir> | ||
+ | |OPTIONAL | ||
+ | |common argument. The result file will be placed in the specified directory path. | ||
+ | |- | ||
+ | |output_prefix <string> | ||
+ | |OPTIONAL | ||
+ | |common argument. The result file will be prefixed using the specified string. | ||
+ | |} | ||
+ | |||
+ | =Examples= | ||
+ | run h2 on seeg data, using 1-100Hz band.<br> | ||
+ | <syntaxhighlight lang='bash'> | ||
+ | anywave --run h2--input_file d:\data\seeg\data.eeg --time_window 4 --step 0.5 --max_lag 0.1 --hp 1 --lp 100 | ||
+ | </syntaxhighlight> | ||
+ | run with r2 method:<br/> | ||
+ | <syntaxhighlight lang='bash'> | ||
+ | anywave --run h2--input_file d:\data\seeg\data.eeg --algorithm r2 --time_window 4 --step 0.5 --max_lag 0.1 --hp 1 --lp 100 | ||
+ | </syntaxhighlight> |
Revision as of 15:21, 14 April 2020
Arguments description for plugin H2
plugin name: h2
argument | requirement | description |
---|---|---|
input_file <file> | MANDATORY | common argument |
time_window <value> | MANDATORY | time window in seconds. |
step <value> | MANDATORY | step in seconds. |
max_lag <value> | MANDATORY | maximum lag in seconds. |
hp <value> | OPTIONAL | common hp argument. |
lp <value> | OPTIONAL | common lp argument. |
algorithm <r2,h2> | OPTIONAL | algorithm method to compute correlation. Default is h2. |
downsampling <flag> | OPTIONAL | Downsampling data before computing. Default is false |
infomax_extended <flag> | OPTIONAL | Use the extended option for Infomax. Default is false. |
skip_bad <flag> | OPTIONAL | Skip bad channels. Default is true. |
skip_markers <marker name> | OPTIONAL | common argument. ICA will skip all the data sections marked by the specified marker. |
use_markers <marker name> | OPTIONAL | common argument. ICA will only compute on data sections marked by the specified marker. |
output_dir <dir> | OPTIONAL | common argument. The result file will be placed in the specified directory path. |
output_prefix <string> | OPTIONAL | common argument. The result file will be prefixed using the specified string. |
Examples
run h2 on seeg data, using 1-100Hz band.
anywave --run h2--input_file d:\data\seeg\data.eeg --time_window 4 --step 0.5 --max_lag 0.1 --hp 1 --lp 100
run with r2 method:
anywave --run h2--input_file d:\data\seeg\data.eeg --algorithm r2 --time_window 4 --step 0.5 --max_lag 0.1 --hp 1 --lp 100