Difference between revisions of "AnyWave:CommandLine"

From WikiMEG
Jump to: navigation, search
(Setup parameters and run a processing plugin)
Line 1: Line 1:
 
This is a way to run AnyWave in non GUI mode to process files.<br/>
 
This is a way to run AnyWave in non GUI mode to process files.<br/>
 +
{| style="text-align: center; margin: auto;"
 +
|+ Command Line Operations
 +
|-
 +
| [[File:Menu_cli_tobids.png|400px|link=AnyWave:Download|'''convert a file to BIDS''']] ||  [[File:AwChangeNotes.png|400px|link=AnyWave:ChangeNotes|'''Change notes''']]
 +
|-
 +
| [[File:AwFAQ.png|400px|link=AnyWave:Faq|'''FAQ''']] || [[File:AwTutorials.png|400px|link=AnyWave:Tutorials|'''Tutorials''']]
 +
|-
 +
| [[File:AwPlugins.png|400px|link=AnyWave:PluginsList|'''Plugins''']] || [[File:AwWritePlugins.png|400px|link=AnyWave:DeveloperCorner|Code your own plugins]]
 +
|-
 +
| [[File:Menu_cli.png|400px|link=AnyWave:CommandLine|'''The Command Line Interface of AnyWave''']]
 +
|}
 
=Convert files to BIDS=
 
=Convert files to BIDS=
 
AnyWave is used by some third party softwares to process eeg/ieeg/meg files and convert them to BIDS format.<br/>
 
AnyWave is used by some third party softwares to process eeg/ieeg/meg files and convert them to BIDS format.<br/>

Revision as of 12:40, 14 April 2020

This is a way to run AnyWave in non GUI mode to process files.

Command Line Operations
convert a file to BIDS Change notes
FAQ Tutorials
Plugins Code your own plugins
The Command Line Interface of AnyWave

Convert files to BIDS

AnyWave is used by some third party softwares to process eeg/ieeg/meg files and convert them to BIDS format.
Here is the complete list of options to use to do so:
--toBIDS indicates we want to convert a file to BIDS.
--bids_modality <ieeg|eeg|meg> defines the data modality.REQUIRED
--bids_sub <subject> sets the BIDS subject REQUIRED
--bids_task <task> sets the BIDS task REQUIRED
--bids_ses <session> sets the BIDS session (optional)
--bids_run <run> sets the BIDS run index (optional)
--bids_acq <acq> sets the BIDS acquisition (optional)
--bids_proc <proc> sets the processing applied to the file. (optional)
--bids_output <sidecars|all> defines what output files will be generated (sidecars : only generates .json and .tsv files. all: full conversion)
--bids_format <edf | vhdr> this implies the bids_modaliy was set to eeg or ieeg. Specifies the output file format. Default is vhdr. (optional)

Examples

Convert a file data.eeg containing SEEG recordings to BIDS for subject JohnDoe.

anywave --toBIDS --bids_modality ieeg --input_file d:\data\data.eeg --output_dir d:\data\BIDS --bids_sub johndoe --bids_task rest

Convert a MEG data file (4DNI) to BIDS for subject JohnDoe.
The run number must be specified. Note also that the input is the folder containing the MEG run, not a single file.

anywave --toBIDS --bids_modality meg --input_dir d:\data\MEG\run1 --output_dir d:\data\BIDS --bids_sub johndoe --bids_task rest --bids_run 01

Convert a MEG data file (Elekta) to BIDS for subject JohnDoe.
As everything is stored in one file (.fif), no need here to specify a run number (but you can).
However, the input is still a folder, so specifiy the folder in which the fif file is located.

anywave --toBIDS --bids_modality meg --input_dir d:\data\MEG --output_dir d:\data\BIDS --bids_sub johndoe --bids_task rest

Process files

AnyWave can also process data files, running a specific process (plugin) to a bunch a files or directories.
The keyword to do that kind of opteration is :
--run <plugin name | json file | json string>
To run a plugin, the user must set all the required parameters as well as input and output options.
The other requirement is that the plugin CAN run in batch mode.
See the dedicated section to see how to make your plugin compatible or simply browse the list of compatible built-in plugins.
There is a list of common command line keywords that can be used anytime by every plug-ins:
--input_file <file> set the file to process.
--input_dir <dir> sets the input directory to use.
--output_dir <dir> sets the output directory. The location where the plugin should generate its results.
--output_file <file> sets the name of the processing output file.
--output_prefix <string> sets the prefix of the output file.
--hp <value> sets the high pass filter value to use.
--lp <value> sets the low pass filter value to use.
--notch <value> sets the notch filter value to use.

Setup parameters and run a processing plugin

Processing a file relies on a specific plugin which need to be setup using specific parameters.
There are several ways to setup plugin parameters and run it:
1. use a json file to describe all the parameters.
2. use a json string to describe all the parameters.
3. use a plugin which declares its parameters.

Examples:
Suppose we want to run a processing using a plugin named ProcessPlugin.
This ProcessPlugin requires two parameters, a time window (s) and a threshold value.
The expected parameters are : time_window, threshold.
If the plugin published its required arguments to AnyWave, you can do :

anywave --run ProcessPlugin --input_file d:\data\my_file.eeg --time_window 4 --threshold 0.3

Note the input_file common keyword that set the data file to be processed by the plugin.
If the command fails, you'd probably need to use the json way:
Create a parameters.json file as follow:

{ 
"plugin" : "ProcessPlugin",
"time_window" : 4,
"threshold" : 0.3
}

and use the command line:

anywave --run parameters.json --input_file d:\data\my_file.eeg

This way AnyWave will read the parameters from the json file and setup the plugin accordingly.
Note the you can also use the common keywords inside your json file:

{ 
"plugin" : "ProcessPlugin",
"input_file" : "d:\\data\\my_file.eeg",
"time_window" : 4,
"threshold" : 0.3
}

Although it does not make sense there to specify input_file, you can do it. You can also write down the json string on the command line after the --run keyword:

anywave --run "{ """plugin""" : """ProcessPlugin""", """time_window""" : 4, """threshold""" : 0.3 }" --input_file d:\data\my_file.eeg