-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathwonambi.widgets.info.html
443 lines (400 loc) · 28.9 KB
/
wonambi.widgets.info.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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
<!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.widgets.info 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.widgets.labels module" href="wonambi.widgets.labels.html" />
<link rel="prev" title="wonambi.widgets.detect_dialogs module" href="wonambi.widgets.detect_dialogs.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.widgets.html">wonambi.widgets package</a></li>
<li class="breadcrumb-item active">wonambi.widgets.info 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.widgets.info">
<span id="wonambi-widgets-info-module"></span><h1>wonambi.widgets.info module<a class="headerlink" href="#module-wonambi.widgets.info" title="Permalink to this heading"></a></h1>
<p>Widget with general information about the dataset.</p>
<dl class="py class">
<dt class="sig sig-object py" id="wonambi.widgets.info.ExportDatasetDialog">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">wonambi.widgets.info.</span></span><span class="sig-name descname"><span class="pre">ExportDatasetDialog</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/widgets/info.html#ExportDatasetDialog"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.widgets.info.ExportDatasetDialog" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">QDialog</span></code></p>
<p>Dialog for choosing export dataset options.</p>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.widgets.info.ExportDatasetDialog.button_clicked">
<span class="sig-name descname"><span class="pre">button_clicked</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">button</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/widgets/info.html#ExportDatasetDialog.button_clicked"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.widgets.info.ExportDatasetDialog.button_clicked" title="Permalink to this definition"></a></dt>
<dd><p>Action when button was clicked.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>button</strong> (<em>instance</em><em> of </em><em>QPushButton</em>) – which button was pressed</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.widgets.info.ExportDatasetDialog.create_dialog">
<span class="sig-name descname"><span class="pre">create_dialog</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/widgets/info.html#ExportDatasetDialog.create_dialog"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.widgets.info.ExportDatasetDialog.create_dialog" title="Permalink to this definition"></a></dt>
<dd><p>Create the dialog.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.widgets.info.ExportDatasetDialog.get_channels">
<span class="sig-name descname"><span class="pre">get_channels</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/widgets/info.html#ExportDatasetDialog.get_channels"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.widgets.info.ExportDatasetDialog.get_channels" title="Permalink to this definition"></a></dt>
<dd><p>Get the selected channel(s in order).</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.widgets.info.ExportDatasetDialog.save_as">
<span class="sig-name descname"><span class="pre">save_as</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/widgets/info.html#ExportDatasetDialog.save_as"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.widgets.info.ExportDatasetDialog.save_as" title="Permalink to this definition"></a></dt>
<dd><p>Dialog for getting name, location of dataset export.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.widgets.info.ExportDatasetDialog.toggle_buttons">
<span class="sig-name descname"><span class="pre">toggle_buttons</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/widgets/info.html#ExportDatasetDialog.toggle_buttons"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.widgets.info.ExportDatasetDialog.toggle_buttons" title="Permalink to this definition"></a></dt>
<dd><p>Turn buttons on and off.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.widgets.info.ExportDatasetDialog.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/widgets/info.html#ExportDatasetDialog.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.widgets.info.ExportDatasetDialog.update" title="Permalink to this definition"></a></dt>
<dd><p>Get info from dataset before opening dialog.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="wonambi.widgets.info.Info">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">wonambi.widgets.info.</span></span><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/widgets/info.html#Info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.widgets.info.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">QWidget</span></code></p>
<p>Display information about the dataset.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="wonambi.widgets.info.Info.parent">
<span class="sig-name descname"><span class="pre">parent</span></span><a class="headerlink" href="#wonambi.widgets.info.Info.parent" title="Permalink to this definition"></a></dt>
<dd><p>the main window.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>instance of QMainWindow</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="wonambi.widgets.info.Info.filename">
<span class="sig-name descname"><span class="pre">filename</span></span><a class="headerlink" href="#wonambi.widgets.info.Info.filename" title="Permalink to this definition"></a></dt>
<dd><p>the full path of the file.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="wonambi.widgets.info.Info.dataset">
<span class="sig-name descname"><span class="pre">dataset</span></span><a class="headerlink" href="#wonambi.widgets.info.Info.dataset" title="Permalink to this definition"></a></dt>
<dd><p>the dataset already read in.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>instance of wonambi.Dataset</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="wonambi.widgets.info.Info.markers">
<span class="sig-name descname"><span class="pre">markers</span></span><a class="headerlink" href="#wonambi.widgets.info.Info.markers" title="Permalink to this definition"></a></dt>
<dd><p>list of the markers in the dataset</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="wonambi.widgets.info.Info.idx_filename">
<span class="sig-name descname"><span class="pre">idx_filename</span></span><a class="headerlink" href="#wonambi.widgets.info.Info.idx_filename" title="Permalink to this definition"></a></dt>
<dd><p>button to select dataset / show current dataset</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>QPushButton</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="wonambi.widgets.info.Info.idx_s_freq">
<span class="sig-name descname"><span class="pre">idx_s_freq</span></span><a class="headerlink" href="#wonambi.widgets.info.Info.idx_s_freq" title="Permalink to this definition"></a></dt>
<dd><p>show sampling frequency</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>QLabel</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="wonambi.widgets.info.Info.idx_n_chan">
<span class="sig-name descname"><span class="pre">idx_n_chan</span></span><a class="headerlink" href="#wonambi.widgets.info.Info.idx_n_chan" title="Permalink to this definition"></a></dt>
<dd><p>show number of channels</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>QLabel</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="wonambi.widgets.info.Info.idx_start_time">
<span class="sig-name descname"><span class="pre">idx_start_time</span></span><a class="headerlink" href="#wonambi.widgets.info.Info.idx_start_time" title="Permalink to this definition"></a></dt>
<dd><p>show start time of the dataset</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>QLabel</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="wonambi.widgets.info.Info.idx_end_time">
<span class="sig-name descname"><span class="pre">idx_end_time</span></span><a class="headerlink" href="#wonambi.widgets.info.Info.idx_end_time" title="Permalink to this definition"></a></dt>
<dd><p>show end time of the dataset</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>QLabel</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="wonambi.widgets.info.Info.idx_start">
<span class="sig-name descname"><span class="pre">idx_start</span></span><a class="headerlink" href="#wonambi.widgets.info.Info.idx_start" title="Permalink to this definition"></a></dt>
<dd><p>show start time of the window</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>QLabel</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="wonambi.widgets.info.Info.idx_length">
<span class="sig-name descname"><span class="pre">idx_length</span></span><a class="headerlink" href="#wonambi.widgets.info.Info.idx_length" title="Permalink to this definition"></a></dt>
<dd><p>show length of the time window</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>QLabel</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="wonambi.widgets.info.Info.idx_scaling">
<span class="sig-name descname"><span class="pre">idx_scaling</span></span><a class="headerlink" href="#wonambi.widgets.info.Info.idx_scaling" title="Permalink to this definition"></a></dt>
<dd><p>show current scaling</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>QLabel</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="wonambi.widgets.info.Info.idx_distance">
<span class="sig-name descname"><span class="pre">idx_distance</span></span><a class="headerlink" href="#wonambi.widgets.info.Info.idx_distance" title="Permalink to this definition"></a></dt>
<dd><p>show current distance between traces</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>QLabel</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.widgets.info.Info.create">
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/widgets/info.html#Info.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.widgets.info.Info.create" title="Permalink to this definition"></a></dt>
<dd><p>Create the widget layout with all the information.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.widgets.info.Info.create_action">
<span class="sig-name descname"><span class="pre">create_action</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/widgets/info.html#Info.create_action"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.widgets.info.Info.create_action" title="Permalink to this definition"></a></dt>
<dd><p>Create actions associated with this widget.</p>
<p class="rubric">Notes</p>
<p>I think that this should be a function or a property.</p>
<p>The good thing about the property is that it is updated every time you
run it (for example, if you change some parameters in the settings).
The main drawback is that you cannot reference back to the QAction, as
it creates new ones every time.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.widgets.info.Info.display_dataset">
<span class="sig-name descname"><span class="pre">display_dataset</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/widgets/info.html#Info.display_dataset"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.widgets.info.Info.display_dataset" title="Permalink to this definition"></a></dt>
<dd><p>Update the widget with information about the dataset.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.widgets.info.Info.display_view">
<span class="sig-name descname"><span class="pre">display_view</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/widgets/info.html#Info.display_view"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.widgets.info.Info.display_view" title="Permalink to this definition"></a></dt>
<dd><p>Update information about the size of the traces.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.widgets.info.Info.export">
<span class="sig-name descname"><span class="pre">export</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">new_format</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">chan</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">begtime</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">endtime</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/widgets/info.html#Info.export"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.widgets.info.Info.export" title="Permalink to this definition"></a></dt>
<dd><p>Export current dataset to wonambi format (.won).</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>new_format</strong> (<em>str</em>) – Format for exported record: ‘edf’ or ‘wonambi’</p></li>
<li><p><strong>filename</strong> (<em>str</em><em> or </em><em>PosixPath</em>) – filename to export to</p></li>
<li><p><strong>chan</strong> (<em>list</em><em> of </em><em>str</em><em>, </em><em>opt</em>) – list of original channel names to export. if None, all channels are
exported</p></li>
<li><p><strong>begtime</strong> (<em>int</em><em> or </em><em>datedelta</em><em> or </em><em>datetime</em>) – start of the data to read;
if it’s int or float, it’s assumed it’s s;
if it’s timedelta, it’s assumed from the start of the recording;
if it’s datetime, it’s assumed it’s absolute time.</p></li>
<li><p><strong>endtime</strong> (<em>int</em><em> or </em><em>datedelta</em><em> or </em><em>datetime</em>) – end of the data to read;
if it’s int or float, it’s assumed it’s s;
if it’s timedelta, it’s assumed from the start of the recording;
if it’s datetime, it’s assumed it’s absolute time.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.widgets.info.Info.open_dataset">
<span class="sig-name descname"><span class="pre">open_dataset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">recent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debug_filename</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bids</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/widgets/info.html#Info.open_dataset"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.widgets.info.Info.open_dataset" title="Permalink to this definition"></a></dt>
<dd><p>Open a new dataset.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>recent</strong> (<em>path to file</em>) – one of the recent datasets to read</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.widgets.info.Info.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/widgets/info.html#Info.reset"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.widgets.info.Info.reset" title="Permalink to this definition"></a></dt>
<dd><p>Reset widget to original state.</p>
</dd></dl>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="wonambi.widgets.detect_dialogs.html" class="btn btn-neutral float-left" title="wonambi.widgets.detect_dialogs module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="wonambi.widgets.labels.html" class="btn btn-neutral float-right" title="wonambi.widgets.labels module" 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>