-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcmd.html
224 lines (203 loc) · 12.8 KB
/
cmd.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Command Line — wonambi 7.11 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="shortcut icon" href="_static/wonambi.ico"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Graphical User Interface" href="gui/index.html" />
<link rel="prev" title="Plot 3D images" href="analysis/plot3d.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> wonambi
<img src="_static/wonambi.png" class="logo" alt="Logo"/>
</a>
<div class="version">
7.11
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">WONAMBI</a><ul>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#features">Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#run-it">Run it!</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#documentation">Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#change-log">Change Log</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#optional-requirements">Optional Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#status">Status</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#license">License</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#linux-mac-os-x">Linux / Mac OS X</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#windows">Windows</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="analysis/index.html">Tutorial / Analysis</a><ul>
<li class="toctree-l2"><a class="reference internal" href="analysis/tutorial.html">Get Started</a></li>
<li class="toctree-l2"><a class="reference internal" href="analysis/spectrum.html">Frequency Domain</a></li>
<li class="toctree-l2"><a class="reference internal" href="analysis/plot3d.html">Plot 3D images</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Command Line</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#wonambi">wonambi</a></li>
<li class="toctree-l2"><a class="reference internal" href="#won-convert">won_convert</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="gui/index.html">Graphical User Interface</a><ul>
<li class="toctree-l2"><a class="reference internal" href="gui/open.html">Open Dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="gui/labels.html">Edit Labels</a></li>
<li class="toctree-l2"><a class="reference internal" href="gui/channels.html">Plot Channels</a></li>
<li class="toctree-l2"><a class="reference internal" href="gui/traces.html">Navigation</a></li>
<li class="toctree-l2"><a class="reference internal" href="gui/notes.html">Annotations</a></li>
<li class="toctree-l2"><a class="reference internal" href="gui/detect.html">Event detection</a></li>
<li class="toctree-l2"><a class="reference internal" href="gui/methods.html">Detection methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="gui/analysis.html">Analysis console</a></li>
<li class="toctree-l2"><a class="reference internal" href="gui/screenshot.html">Screenshot</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/wonambi.html">Modules, classes, functions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/wonambi.html#subpackages">Subpackages</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/wonambi.html#submodules">Submodules</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="testing.html">Development</a><ul>
<li class="toctree-l2"><a class="reference internal" href="testing.html#prepare-test-environment">Prepare Test Environment</a></li>
<li class="toctree-l2"><a class="reference internal" href="testing.html#get-files">1. Get Files</a></li>
<li class="toctree-l2"><a class="reference internal" href="testing.html#run-the-tests">2. Run the Tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="testing.html#coverage">3. Coverage</a></li>
<li class="toctree-l2"><a class="reference internal" href="testing.html#documentation">4. Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="testing.html#release">5. Release</a></li>
<li class="toctree-l2"><a class="reference internal" href="testing.html#tips-and-tricks">Tips and Tricks</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Change Log</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-7">Version 7</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-6">Version 6</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-5">Version 5</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-4">Version 4</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-3">Version 3</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-2">Version 2</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-1">Version 1</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="todo.html">TODO</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">wonambi</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a></li>
<li class="breadcrumb-item active">Command Line</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="command-line">
<h1>Command Line<a class="headerlink" href="#command-line" title="Permalink to this heading"></a></h1>
<p>When you install <strong>wonambi</strong>, you’ll have access to some functions in your command line.</p>
<section id="wonambi">
<h2>wonambi<a class="headerlink" href="#wonambi" title="Permalink to this heading"></a></h2>
<p>This is the main command to run the graphical user interface (GUI).</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>usage: wonambi <span class="o">[</span>-h<span class="o">]</span> <span class="o">[</span>-v<span class="o">]</span> <span class="o">[</span>-l LOG<span class="o">]</span> <span class="o">[</span>--reset<span class="o">]</span> <span class="o">[</span>--bids<span class="o">]</span>
<span class="o">[</span>dataset<span class="o">]</span> <span class="o">[</span>annot<span class="o">]</span> <span class="o">[</span>montage<span class="o">]</span>
Package to analyze EEG, ECoG and other electrophysiology formats. It allows
<span class="k">for</span> visualization of the results and <span class="k">for</span> a GUI that can be used to score sleep
stages.
positional arguments:
dataset full path to dataset to open
annot full path to annotations file to open
montage full path to montage file to open
optional arguments:
-h, --help show this <span class="nb">help</span> message and <span class="nb">exit</span>
-v, --version Return version
-l LOG, --log LOG Logging level: info <span class="o">(</span>default<span class="o">)</span>, debug
--reset Reset <span class="o">(</span>clear<span class="o">)</span> configuration file
--bids Read the information stored <span class="k">in</span> the BIDS format
</pre></div>
</div>
</section>
<section id="won-convert">
<h2>won_convert<a class="headerlink" href="#won-convert" title="Permalink to this heading"></a></h2>
<p>This command allows you to convert the data from one format known to <strong>wonambi</strong> into another common format (like <cite>edf</cite>, Brain Vision, BIDS).</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>usage: won_convert <span class="o">[</span>-h<span class="o">]</span> <span class="o">[</span>-v<span class="o">]</span> <span class="o">[</span>-l LOG<span class="o">]</span> <span class="o">[</span>-f SAMPLING_FREQ<span class="o">]</span> <span class="o">[</span>-b BEGTIME<span class="o">]</span>
<span class="o">[</span>-e ENDTIME<span class="o">]</span>
<span class="o">[</span>infile<span class="o">]</span> <span class="o">[</span>outfile<span class="o">]</span>
Convert data from one known format to another format
positional arguments:
infile full path to dataset to convert
outfile full path of the output file with extension <span class="o">(</span>.edf<span class="o">)</span>
optional arguments:
-h, --help show this <span class="nb">help</span> message and <span class="nb">exit</span>
-v, --version Return version
-l LOG, --log LOG Logging level: info <span class="o">(</span>default<span class="o">)</span>, debug
-f SAMPLING_FREQ, --sampling_freq SAMPLING_FREQ
resample to this frequency <span class="o">(</span><span class="k">in</span> Hz<span class="o">)</span>
-b BEGTIME, --begtime BEGTIME
start <span class="nb">time</span> <span class="k">in</span> seconds from the beginning of the
recordings
-e ENDTIME, --endtime ENDTIME
end <span class="nb">time</span> <span class="k">in</span> seconds from the beginning of the
recordings
</pre></div>
</div>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="analysis/plot3d.html" class="btn btn-neutral float-left" title="Plot 3D images" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="gui/index.html" class="btn btn-neutral float-right" title="Graphical User Interface" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2013-2022, Gio Piantoni / Jordan O'Byrne.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(false);
});
</script>
</body>
</html>