Difference between revisions of "AnyWave::CLI"

From WikiMEG
Jump to: navigation, search
Line 19: Line 19:
 
|}
 
|}
  
= run a process =
+
== run a process ==
 
Some of the plugins in AnyWave can be executed from the command line.<br/>
 
Some of the plugins in AnyWave can be executed from the command line.<br/>
 
This is the case for example, for the ICA plugin: <br/>
 
This is the case for example, for the ICA plugin: <br/>
Line 36: Line 36:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
== JSON contents ==
+
=== JSON contents ===
 
at least one key needs to be present:<br/>
 
at least one key needs to be present:<br/>
 
* plugin : name of the process to execute.
 
* plugin : name of the process to execute.

Revision as of 15:31, 12 June 2019

Command Line Options

AnyWave can execute some operation without any user interactions. This is also useful to batch some operations.

Common options

Option Value Description
--input_file file the file to open.
--output_file file The file to create.
--output_dir folder The output folder where to place files created by the command.
--hp value The High Pass filter (in Hz) to apply when reading data.
--lp value The Low Pass filter (in Hz) to apply when reading data.
--notch value The notch (in Hz) to apply when reading data.

run a process

Some of the plugins in AnyWave can be executed from the command line.
This is the case for example, for the ICA plugin:
To run a process plugin, you have to create a json file or string and pass it as an option:

anywave --run myprocess.json

Example for the ica:

{
"plugin" : "ica",
"input_file" : "/path/to/datafile.dat",
"comp" : 50,
"modality" : "MEG"
}

JSON contents

at least one key needs to be present:

  • plugin : name of the process to execute.