Difference between revisions of "AnyWave::CLI"

From WikiMEG
Jump to: navigation, search
(Common options)
Line 2: Line 2:
 
AnyWave can execute some operation without any user interactions. This is also useful to batch some operations. <br/>
 
AnyWave can execute some operation without any user interactions. This is also useful to batch some operations. <br/>
 
==Common options==
 
==Common options==
--input_file <path>  : a path to the input file.<br />
+
{| class="wikitable"
--output_file <path> : the name of the output file.<br />
+
|-
--output_dir <path> : the path to the output folder where the output file will be created.<br />
+
! Option !! Value !! Description
--output_format <vhdr, edf, MATLAB, ADES> : the output file format.<br />
+
|-
--skip_marker <label> : the label of a marker to skip while reading data.<br />
+
| --input_file || file || the file to open.
--hp <value> : The high pass filter value to apply to data.<br/>
+
|-
--lp <value> : The low pass filter value to apply to data.<br />
+
| --output_file || file || The file to create.
--notch <value> : The notch filter to apply to date.<br/>
+
|-
 +
| --output_dir  || folder || The output folder where to place files created by the command.
 +
|-
 +
| --output_format || string || The file format to use for output data file (vhdr, EDF, MATLAB, ADES).
 +
|-
 +
| --skip_marker || string || A specific marker to skip when reading data. (rejecting artefacted data).
 +
|-
 +
| --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.
 +
|}
  
 
== Convert a file ==
 
== Convert a file ==

Revision as of 10:49, 18 February 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.
--output_format string The file format to use for output data file (vhdr, EDF, MATLAB, ADES).
--skip_marker string A specific marker to skip when reading data. (rejecting artefacted data).
--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.

Convert a file