Difference between revisions of "AnyWave::CLI"
From WikiMEG
(→Common options) |
(→run a process) |
||
| (12 intermediate revisions by one user not shown) | |||
| Line 11: | Line 11: | ||
|- | |- | ||
| --output_dir || folder || The output folder where to place files created by the command. | | --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. | | --hp || value || The High Pass filter (in Hz) to apply when reading data. | ||
| Line 23: | Line 19: | ||
|} | |} | ||
| − | == | + | == run a process == |
| + | 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/> | ||
| + | To run a process plugin, you have to create a json file or string and pass it as an option:<br/> | ||
| + | <syntaxhighlight lang="bash"> | ||
| + | anywave --run myprocess.json | ||
| + | </syntaxhighlight> | ||
| + | Example for the ica:<br/> | ||
| + | <syntaxhighlight lang="javascript"> | ||
| + | { | ||
| + | "plugin" : "ica", | ||
| + | "input_file" : "/path/to/datafile.dat", | ||
| + | "comp" : 50, | ||
| + | "modality" : "MEG" | ||
| + | } | ||
| + | </syntaxhighlight> | ||
| + | Note: the input_file is specified in the json but can also be specified from the command line : <br/> | ||
| + | <syntaxhighlight lang="bash"> | ||
| + | anywave --run myprocess.json --input_file /path/to/datafile.dat | ||
| + | </syntaxhighlight> | ||
| + | === JSON contents === | ||
| + | at least one key needs to be present:<br/> | ||
| + | * plugin : name of the process to execute. | ||
Latest revision as of 15:34, 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.jsonExample for the ica:
{ "plugin" : "ica", "input_file" : "/path/to/datafile.dat", "comp" : 50, "modality" : "MEG" }
Note: the input_file is specified in the json but can also be specified from the command line :
anywave --run myprocess.json --input_file /path/to/datafile.dat
JSON contents
at least one key needs to be present:
- plugin : name of the process to execute.
