-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathwonambi.dataset.html
390 lines (366 loc) · 24.6 KB
/
wonambi.dataset.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
<!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.dataset 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.datatype module" href="wonambi.datatype.html" />
<link rel="prev" title="wonambi.widgets.video module" href="wonambi.widgets.video.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"><a class="reference internal" href="wonambi.html#subpackages">Subpackages</a></li>
<li class="toctree-l2 current"><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 active">wonambi.dataset 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.dataset">
<span id="wonambi-dataset-module"></span><h1>wonambi.dataset module<a class="headerlink" href="#module-wonambi.dataset" title="Permalink to this heading"></a></h1>
<p>Module has information about the datasets, not data.</p>
<dl class="py class">
<dt class="sig sig-object py" id="wonambi.dataset.Dataset">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">wonambi.dataset.</span></span><span class="sig-name descname"><span class="pre">Dataset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">IOClass</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">session</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/dataset.html#Dataset"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.dataset.Dataset" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Contain specific information and methods, associated with a dataset.</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>filename</strong> (<em>str</em><em> or </em><a class="reference internal" href="wonambi.widgets.utils.html#wonambi.widgets.utils.Path" title="wonambi.widgets.utils.Path"><em>Path</em></a>) – name of the file</p></li>
<li><p><strong>IOClass</strong> (<em>class</em>) – one of the classes of wonambi.ioeeg</p></li>
<li><p><strong>bids</strong> (<em>bool</em>) – whether you give precedence to the information stored in the accompanying
files which are in the BIDS format</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="wonambi.dataset.Dataset.filename">
<span class="sig-name descname"><span class="pre">filename</span></span><a class="headerlink" href="#wonambi.dataset.Dataset.filename" title="Permalink to this definition"></a></dt>
<dd><p>name 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.dataset.Dataset.IOClass">
<span class="sig-name descname"><span class="pre">IOClass</span></span><a class="headerlink" href="#wonambi.dataset.Dataset.IOClass" title="Permalink to this definition"></a></dt>
<dd><p>format of the file</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>class</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="wonambi.dataset.Dataset.header">
<span class="sig-name descname"><span class="pre">header</span></span><a class="headerlink" href="#wonambi.dataset.Dataset.header" title="Permalink to this definition"></a></dt>
<dd><ul class="simple">
<li><dl class="simple">
<dt>subj_id<span class="classifier">str</span></dt><dd><p>subject identification code</p>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>start_time<span class="classifier">datetime</span></dt><dd><p>start time of the dataset. If it cannot get the start time from the
header, wonambi reads it from the timestamp of the file</p>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>s_freq<span class="classifier">float</span></dt><dd><p>sampling frequency</p>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>chan_name<span class="classifier">list of str</span></dt><dd><p>list of all the channels</p>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>n_samples<span class="classifier">int</span></dt><dd><p>number of samples in the dataset</p>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>orig<span class="classifier">dict</span></dt><dd><p>additional information taken directly from the header</p>
</dd>
</dl>
</li>
</ul>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>dict</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="wonambi.dataset.Dataset.dataset">
<span class="sig-name descname"><span class="pre">dataset</span></span><a class="headerlink" href="#wonambi.dataset.Dataset.dataset" title="Permalink to this definition"></a></dt>
<dd><dl class="simple">
<dt>this requires at least three attributes:</dt><dd><ul class="simple">
<li><p>filename</p></li>
<li><p>return_hdr</p></li>
<li><p>return_dat</p></li>
</ul>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>instance of a class which depends on format,</p>
</dd>
</dl>
</dd></dl>
<p class="rubric">Notes</p>
<p>There is a difference between Dataset.filename and Dataset.dataset.filename
because the former is where the file that you want to read (the argument),
while the latter is the file that you really read. There might be
differences, for example, if the argument points to a file within a
directory, or if the file is mapped to memory.</p>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.dataset.Dataset.read_data">
<span class="sig-name descname"><span class="pre">read_data</span></span><span class="sig-paren">(</span><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>, <em class="sig-param"><span class="n"><span class="pre">begsam</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">endsam</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">events</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">pre</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">post</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">s_freq</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/dataset.html#Dataset.read_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.dataset.Dataset.read_data" title="Permalink to this definition"></a></dt>
<dd><p>Read the data and creates a ChanTime instance</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>chan</strong> (<em>list</em><em> of </em><em>strings</em>) – names of the channels to read</p></li>
<li><p><strong>begtime</strong> (<em>int</em><em> or </em><em>timedelta</em><em> or </em><em>datetime</em><em> or </em><em>list</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.
It can also be a list of any of the above type.</p></li>
<li><p><strong>endtime</strong> (<em>int</em><em> or </em><em>timedelta</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.
It can also be a list of any of the above type.</p></li>
<li><p><strong>begsam</strong> (<em>int</em>) – first sample (this sample will be included)</p></li>
<li><p><strong>endsam</strong> (<em>int</em>) – last sample (this sample will NOT be included)</p></li>
<li><p><strong>events</strong> (<em>list</em><em> of </em><em>int</em><em> or </em><em>of timedelta</em><em> or </em><em>of datetime</em>) – list of the onset time of the events of interest.
This option is useful if you want to run a trial-based analysis.</p></li>
<li><p><strong>pre</strong> (<em>float</em>) – only when “events” is specified, the amount of data before each
event to be included (in s). Use a positive number to indicate
the time before the event.</p></li>
<li><p><strong>post</strong> (<em>float</em>) – only when “events” is specified, the amount of data after each
event to be included (in s).</p></li>
<li><p><strong>s_freq</strong> (<em>int</em>) – sampling frequency of the data</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><em>An instance of ChanTime</em></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>begsam and endsam follow Python convention, which starts at zero,
includes begsam but DOES NOT include endsam.</p>
<p>If begtime and endtime are a list, the two lists should have the same
length and the data will be stored in trials.</p>
<p>If neither begtime or begsam are specified, it starts from the first
sample. If neither endtime or endsam are specified, it reads until the
end.</p>
<p>The time axis will indicate the time in seconds from data.start_time,
unless you specify “events”. In that case, time will run from -“pre” to
+”post”.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.dataset.Dataset.read_markers">
<span class="sig-name descname"><span class="pre">read_markers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/dataset.html#Dataset.read_markers"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.dataset.Dataset.read_markers" title="Permalink to this definition"></a></dt>
<dd><p>Return the markers. You can add optional arguments that will be
passed to the method specific for each datafile.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="wonambi.dataset.Dataset.read_videos">
<span class="sig-name descname"><span class="pre">read_videos</span></span><span class="sig-paren">(</span><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/dataset.html#Dataset.read_videos"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.dataset.Dataset.read_videos" title="Permalink to this definition"></a></dt>
<dd><p>Return list of videos with start and end times for a period.</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>begtime</strong> (<em>int</em><em> or </em><em>timedelta</em><em> or </em><em>datetime</em><em> or </em><em>list</em>) – start of the data to read;
if it’s int, 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.
It can also be a list of any of the above type.</p></li>
<li><p><strong>endtime</strong> (<em>int</em><em> or </em><em>timedelta</em><em> or </em><em>datetime</em>) – end of the data to read;
if it’s int, 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.
It can also be a list of any of the above type.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><ul class="simple">
<li><p><em>list of path</em> – list of absolute paths (as str) to the movie files</p></li>
<li><p><em>float</em> – time in s from the beginning of the first movie when the part of
interest starts</p></li>
<li><p><em>float</em> – time in s from the beginning of the last movie when the part of
interest ends</p></li>
</ul>
</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>OSError</strong> – when there are no video files at all</p></li>
<li><p><strong>IndexError</strong> – when there are video files, but the interval of interest is not in
the list of files.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="wonambi.dataset.detect_format">
<span class="sig-prename descclassname"><span class="pre">wonambi.dataset.</span></span><span class="sig-name descname"><span class="pre">detect_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/wonambi/dataset.html#detect_format"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wonambi.dataset.detect_format" title="Permalink to this definition"></a></dt>
<dd><p>Detect file format.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>filename</strong> (<em>str</em><em> or </em><a class="reference internal" href="wonambi.widgets.utils.html#wonambi.widgets.utils.Path" title="wonambi.widgets.utils.Path"><em>Path</em></a>) – name of the filename or directory.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><ul class="simple">
<li><p><em>class used to read the data.</em></p></li>
<li><p><strong>list</strong> (<em>indices of sessions</em>)</p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="wonambi.widgets.video.html" class="btn btn-neutral float-left" title="wonambi.widgets.video module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="wonambi.datatype.html" class="btn btn-neutral float-right" title="wonambi.datatype 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>