-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathwonambi.bin.scroll_data.html
292 lines (260 loc) · 21.4 KB
/
wonambi.bin.scroll_data.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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
<!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>wonambi.bin.scroll_data module — 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="wonambi.detect package" href="wonambi.detect.html" />
<link rel="prev" title="wonambi.bin.convert module" href="wonambi.bin.convert.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"><a class="reference internal" href="../cmd.html">Command Line</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../cmd.html#wonambi">wonambi</a></li>
<li class="toctree-l2"><a class="reference internal" href="../cmd.html#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 current"><a class="reference internal" href="wonambi.html">Modules, classes, functions</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="wonambi.html#subpackages">Subpackages</a></li>
<li class="toctree-l2"><a class="reference internal" href="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"><a href="wonambi.html">wonambi package</a></li>
<li class="breadcrumb-item"><a href="wonambi.bin.html">wonambi.bin package</a></li>
<li class="breadcrumb-item active">wonambi.bin.scroll_data module</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="module-wonambi.bin.scroll_data">
<span id="wonambi-bin-scroll-data-module"></span><h1>wonambi.bin.scroll_data module<a class="headerlink" href="#module-wonambi.bin.scroll_data" title="Permalink to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="wonambi.bin.scroll_data.MainWindow">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">wonambi.bin.scroll_data.</span></span><span class="sig-name descname"><span class="pre">MainWindow</span></span><a class="reference internal" href="../_modules/wonambi/bin/scroll_data.html#MainWindow"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.bin.scroll_data.MainWindow" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">QMainWindow</span></code></p>
<p>Create an instance of the main window.</p>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.bin.scroll_data.MainWindow.about">
<span class="sig-name descname"><span class="pre">about</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/bin/scroll_data.html#MainWindow.about"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.bin.scroll_data.MainWindow.about" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.bin.scroll_data.MainWindow.closeEvent">
<span class="sig-name descname"><span class="pre">closeEvent</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/bin/scroll_data.html#MainWindow.closeEvent"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.bin.scroll_data.MainWindow.closeEvent" title="Permalink to this definition"></a></dt>
<dd><p>save the name of the last open dataset.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.bin.scroll_data.MainWindow.refresh">
<span class="sig-name descname"><span class="pre">refresh</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/bin/scroll_data.html#MainWindow.refresh"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.bin.scroll_data.MainWindow.refresh" title="Permalink to this definition"></a></dt>
<dd><p>Functions to re-run once settings have been changed.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.bin.scroll_data.MainWindow.reset">
<span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/bin/scroll_data.html#MainWindow.reset"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.bin.scroll_data.MainWindow.reset" title="Permalink to this definition"></a></dt>
<dd><p>Remove all the information from previous dataset before loading a
new dataset.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.bin.scroll_data.MainWindow.show_analysis_dialog">
<span class="sig-name descname"><span class="pre">show_analysis_dialog</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/bin/scroll_data.html#MainWindow.show_analysis_dialog"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.bin.scroll_data.MainWindow.show_analysis_dialog" title="Permalink to this definition"></a></dt>
<dd><p>Create the analysis dialog.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.bin.scroll_data.MainWindow.show_event_analysis_dialog">
<span class="sig-name descname"><span class="pre">show_event_analysis_dialog</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/bin/scroll_data.html#MainWindow.show_event_analysis_dialog"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.bin.scroll_data.MainWindow.show_event_analysis_dialog" title="Permalink to this definition"></a></dt>
<dd><p>Create the event analysis dialog.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.bin.scroll_data.MainWindow.show_export_dataset_dialog">
<span class="sig-name descname"><span class="pre">show_export_dataset_dialog</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/bin/scroll_data.html#MainWindow.show_export_dataset_dialog"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.bin.scroll_data.MainWindow.show_export_dataset_dialog" title="Permalink to this definition"></a></dt>
<dd><p>Create the dataset export dialog.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.bin.scroll_data.MainWindow.show_export_events_dialog">
<span class="sig-name descname"><span class="pre">show_export_events_dialog</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/bin/scroll_data.html#MainWindow.show_export_events_dialog"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.bin.scroll_data.MainWindow.show_export_events_dialog" title="Permalink to this definition"></a></dt>
<dd><p>Create the events export dialog.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.bin.scroll_data.MainWindow.show_merge_dialog">
<span class="sig-name descname"><span class="pre">show_merge_dialog</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/bin/scroll_data.html#MainWindow.show_merge_dialog"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.bin.scroll_data.MainWindow.show_merge_dialog" title="Permalink to this definition"></a></dt>
<dd><p>Create the event merging dialog.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.bin.scroll_data.MainWindow.show_plot_dialog">
<span class="sig-name descname"><span class="pre">show_plot_dialog</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/bin/scroll_data.html#MainWindow.show_plot_dialog"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.bin.scroll_data.MainWindow.show_plot_dialog" title="Permalink to this definition"></a></dt>
<dd><p>Create the plot frame widget.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.bin.scroll_data.MainWindow.show_settings">
<span class="sig-name descname"><span class="pre">show_settings</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/bin/scroll_data.html#MainWindow.show_settings"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.bin.scroll_data.MainWindow.show_settings" title="Permalink to this definition"></a></dt>
<dd><p>Open the Setting windows, after updating the values in GUI.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.bin.scroll_data.MainWindow.show_slow_wave_dialog">
<span class="sig-name descname"><span class="pre">show_slow_wave_dialog</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/bin/scroll_data.html#MainWindow.show_slow_wave_dialog"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.bin.scroll_data.MainWindow.show_slow_wave_dialog" title="Permalink to this definition"></a></dt>
<dd><p>Create the SW detection dialog.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.bin.scroll_data.MainWindow.show_spindle_dialog">
<span class="sig-name descname"><span class="pre">show_spindle_dialog</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/bin/scroll_data.html#MainWindow.show_spindle_dialog"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.bin.scroll_data.MainWindow.show_spindle_dialog" title="Permalink to this definition"></a></dt>
<dd><p>Create the spindle detection dialog.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.bin.scroll_data.MainWindow.update">
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/bin/scroll_data.html#MainWindow.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.bin.scroll_data.MainWindow.update" title="Permalink to this definition"></a></dt>
<dd><p>Once you open a dataset, it activates all the widgets.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.bin.scroll_data.MainWindow.value">
<span class="sig-name descname"><span class="pre">value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parameter</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/bin/scroll_data.html#MainWindow.value"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.bin.scroll_data.MainWindow.value" title="Permalink to this definition"></a></dt>
<dd><p>This function is a shortcut for any parameter. Instead of calling
the widget, its config and its values, you can call directly the
parameter.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>parameter</strong> (<em>str</em>) – name of the parameter of interest</p></li>
<li><p><strong>new_value</strong> (<em>str</em><em> or </em><em>float</em><em>, </em><em>optional</em>) – new value for the parameter</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><em>str or float</em> – if you didn’t specify new_value, it returns the current value.</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>It’s important to maintain an organized dict in DEFAULTS which has to
correspond to the values in the widgets, also the name of the widget.
DEFAULTS is used like a look-up table.</p>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="wonambi.bin.scroll_data.main">
<span class="sig-prename descclassname"><span class="pre">wonambi.bin.scroll_data.</span></span><span class="sig-name descname"><span class="pre">main</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/bin/scroll_data.html#main"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.bin.scroll_data.main" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="wonambi.bin.convert.html" class="btn btn-neutral float-left" title="wonambi.bin.convert module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="wonambi.detect.html" class="btn btn-neutral float-right" title="wonambi.detect package" 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>