-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi.html
More file actions
313 lines (205 loc) · 13.9 KB
/
api.html
File metadata and controls
313 lines (205 loc) · 13.9 KB
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
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>API Documentation — pactools 0.1 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/gallery.css" type="text/css" />
<link rel="stylesheet" href="_static/gallery-binder.css" type="text/css" />
<link rel="stylesheet" href="_static/gallery-dataframe.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="pactools.Comodulogram" href="generated/pactools.Comodulogram.html" />
<link rel="prev" title="Phase shift and temporal delay in PAC" href="auto_examples/plot_phase_delay.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"> pactools
</a>
<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="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started with pactools</a></li>
<li class="toctree-l1"><a class="reference internal" href="auto_examples/index.html">Gallery of Examples</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">API Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#phase-amplitude-coupling-pac">Phase amplitude coupling (PAC)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#scikit-learn-gridsearchcv-api">scikit-learn GridSearchCV API</a></li>
<li class="toctree-l2"><a class="reference internal" href="#driven-auto-regressive-dar-models">Driven auto-regressive (DAR) models</a></li>
<li class="toctree-l2"><a class="reference internal" href="#utilities">Utilities</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/pactools/pactools">Fork pactools on Github</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">pactools</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>API Documentation</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/api.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="api-documentation">
<span id="id1"></span><h1>API Documentation<a class="headerlink" href="#api-documentation" title="Permalink to this headline">¶</a></h1>
<div class="section" id="phase-amplitude-coupling-pac">
<h2>Phase amplitude coupling (PAC)<a class="headerlink" href="#phase-amplitude-coupling-pac" title="Permalink to this headline">¶</a></h2>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pactools.Comodulogram.html#pactools.Comodulogram" title="pactools.Comodulogram"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Comodulogram</span></code></a></p></td>
<td><p>An object to compute the comodulogram for phase-amplitude coupling.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/pactools.DelayEstimator.html#pactools.DelayEstimator" title="pactools.DelayEstimator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DelayEstimator</span></code></a></p></td>
<td><p>Estimate the optimal delay between the two components in PAC</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pactools.PeakLocking.html#pactools.PeakLocking" title="pactools.PeakLocking"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PeakLocking</span></code></a></p></td>
<td><p>An object to compute time average and time-frequency averaged with peak-locking, to analyze phase-amplitude coupling.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/pactools.MaskIterator.html#pactools.MaskIterator" title="pactools.MaskIterator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MaskIterator</span></code></a></p></td>
<td><p>Iterator that creates the masks one at a time.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pactools.raw_to_mask.html#pactools.raw_to_mask" title="pactools.raw_to_mask"><code class="xref py py-obj docutils literal notranslate"><span class="pre">raw_to_mask</span></code></a></p></td>
<td><p>A function to transform MNE data into pactools input signals.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/pactools.simulate_pac.html#pactools.simulate_pac" title="pactools.simulate_pac"><code class="xref py py-obj docutils literal notranslate"><span class="pre">simulate_pac</span></code></a></p></td>
<td><p>Simulate a 1D signal with artificial phase amplitude coupling (PAC).</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="scikit-learn-gridsearchcv-api">
<h2>scikit-learn GridSearchCV API<a class="headerlink" href="#scikit-learn-gridsearchcv-api" title="Permalink to this headline">¶</a></h2>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pactools.DARSklearn.html#pactools.DARSklearn" title="pactools.DARSklearn"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DARSklearn</span></code></a></p></td>
<td><p>Different interface to DAR models, to use in scikit-learn’s GridSearchCV</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/pactools.ExtractDriver.html#pactools.ExtractDriver" title="pactools.ExtractDriver"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ExtractDriver</span></code></a></p></td>
<td><p>Returns bandpass filtered and a highpass filtered signals</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pactools.AddDriverDelay.html#pactools.AddDriverDelay" title="pactools.AddDriverDelay"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AddDriverDelay</span></code></a></p></td>
<td><p>Transformer which adds a time delay in the driver of a DAR model</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/pactools.MultipleArray.html#pactools.MultipleArray" title="pactools.MultipleArray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MultipleArray</span></code></a></p></td>
<td><p>Store a list of arrays into a single object and handle indexing for them</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="driven-auto-regressive-dar-models">
<h2>Driven auto-regressive (DAR) models<a class="headerlink" href="#driven-auto-regressive-dar-models" title="Permalink to this headline">¶</a></h2>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pactools.dar_model.DAR.html#pactools.dar_model.DAR" title="pactools.dar_model.DAR"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DAR</span></code></a></p></td>
<td><p>A driven auto-regressive (DAR) model, as described in [1].</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/pactools.dar_model.StableDAR.html#pactools.dar_model.StableDAR" title="pactools.dar_model.StableDAR"><code class="xref py py-obj docutils literal notranslate"><span class="pre">StableDAR</span></code></a></p></td>
<td><p>A stable driven auto-regressive (DAR) model, as described in [1].</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pactools.dar_model.extract_driver.html#pactools.dar_model.extract_driver" title="pactools.dar_model.extract_driver"><code class="xref py py-obj docutils literal notranslate"><span class="pre">extract_driver</span></code></a></p></td>
<td><p>Extract the driver with filtering and fill the rest of the signal.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="utilities">
<h2>Utilities<a class="headerlink" href="#utilities" title="Permalink to this headline">¶</a></h2>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pactools.utils.fir.BandPassFilter.html#pactools.utils.fir.BandPassFilter" title="pactools.utils.fir.BandPassFilter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">fir.BandPassFilter</span></code></a></p></td>
<td><p>Band-pass FIR filter</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/pactools.utils.fir.LowPassFilter.html#pactools.utils.fir.LowPassFilter" title="pactools.utils.fir.LowPassFilter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">fir.LowPassFilter</span></code></a></p></td>
<td><p>Low-pass FIR filter</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pactools.utils.spectrum.Spectrum.html#pactools.utils.spectrum.Spectrum" title="pactools.utils.spectrum.Spectrum"><code class="xref py py-obj docutils literal notranslate"><span class="pre">spectrum.Spectrum</span></code></a></p></td>
<td><p>Spectral estimator following Welch’s method</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/pactools.utils.spectrum.Coherence.html#pactools.utils.spectrum.Coherence" title="pactools.utils.spectrum.Coherence"><code class="xref py py-obj docutils literal notranslate"><span class="pre">spectrum.Coherence</span></code></a></p></td>
<td><p>Coherence estimator</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/pactools.utils.spectrum.Bicoherence.html#pactools.utils.spectrum.Bicoherence" title="pactools.utils.spectrum.Bicoherence"><code class="xref py py-obj docutils literal notranslate"><span class="pre">spectrum.Bicoherence</span></code></a></p></td>
<td><p>Bicoherence estimator</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/pactools.utils.peak_finder.peak_finder.html#pactools.utils.peak_finder.peak_finder" title="pactools.utils.peak_finder.peak_finder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">peak_finder.peak_finder</span></code></a></p></td>
<td><p>Noise tolerant fast peak finding algorithm</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="generated/pactools.Comodulogram.html" class="btn btn-neutral float-right" title="pactools.Comodulogram" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="auto_examples/plot_phase_delay.html" class="btn btn-neutral float-left" title="Phase shift and temporal delay in PAC" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2017, Tom Dupre la Tour
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>