-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.html
254 lines (231 loc) · 15 KB
/
api.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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>API Documentation — hemolearn 0.0.0 documentation</title>
<link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/gallery.css" />
<link rel="stylesheet" type="text/css" href="_static/gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="_static/gallery-dataframe.css" />
<link rel="stylesheet" type="text/css" href="_static/gallery-rendered-html.css" />
<script 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.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="hemolearn.BDA" href="_autosummary/hemolearn.BDA.html" />
<link rel="prev" title="EUSIPCO 2019 CHerkaoui et a.l. experimental reproduction" href="auto_examples/03_eusipco_2019/slrda_simulated_bold_error_curve.html" />
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
<script type="text/javascript" src="_static/js/jquery-1.11.0.min.js "></script>
<script type="text/javascript" src="_static/js/jquery-fix.js "></script>
<script type="text/javascript" src="_static/bootstrap-3.3.7/js/bootstrap.min.js "></script>
<script type="text/javascript" src="_static/bootstrap-sphinx.js "></script>
</head><body>
<div id="navbar" class="navbar navbar-inverse navbar-default navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html"><span><img src="_static/logo_hemolearn.png"></span>
hemolearn</a>
<span class="navbar-text navbar-version pull-left"><b></b></span>
</div>
<div class="collapse navbar-collapse nav-collapse">
<ul class="nav navbar-nav">
<li><a href="model.html">Model</a></li>
<li><a href="auto_examples/index.html">Examples</a></li>
<li><a href="#">API</a></li>
<li><a href="bibliography.html">Bibliography</a></li>
<li><a href="https://github.com/hemolearn">GitHub</a></li>
<li class="dropdown globaltoc-container">
<a role="button"
id="dLabelGlobalToc"
data-toggle="dropdown"
data-target="#"
href="index.html">Site <b class="caret"></b></a>
<ul class="dropdown-menu globaltoc"
role="menu"
aria-labelledby="dLabelGlobalToc"><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="model.html">Model description</a></li>
<li class="toctree-l1"><a class="reference internal" href="auto_examples/index.html">HemoLearn usage examples</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">API Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="bibliography.html">Cite our work</a></li>
</ul>
</ul>
</li>
</ul>
<form class="navbar-form navbar-right" action="search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="body col-md-12 content" role="main">
<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="sparse-low-rank-decomposition-analysis">
<h2>Sparse Low Rank Decomposition Analysis<a class="headerlink" href="#sparse-low-rank-decomposition-analysis" 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="_autosummary/hemolearn.BDA.html#hemolearn.BDA" title="hemolearn.BDA"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hemolearn.BDA</span></code></a>(n_atoms, t_r[, n_times_atom, …])</p></td>
<td><p>Blind Deconvolution Analysis (BDA) is a algorithm to distangle the neural activation and the haemodynamic contributions in the fMRI data (BOLD signal).</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/hemolearn.deconvolution.blind_deconvolution_multiple_subjects.html#hemolearn.deconvolution.blind_deconvolution_multiple_subjects" title="hemolearn.deconvolution.blind_deconvolution_multiple_subjects"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hemolearn.deconvolution.blind_deconvolution_multiple_subjects</span></code></a>(X, …)</p></td>
<td><p>Multivariate Blind Deconvolution main function for mulitple subjects.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/hemolearn.deconvolution.multi_runs_blind_deconvolution_multiple_subjects.html#hemolearn.deconvolution.multi_runs_blind_deconvolution_multiple_subjects" title="hemolearn.deconvolution.multi_runs_blind_deconvolution_multiple_subjects"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hemolearn.deconvolution.multi_runs_blind_deconvolution_multiple_subjects</span></code></a>(X, …)</p></td>
<td><p>Multiple initialization parallel running version of <cite>blind_deconvolution_single_subject</cite>.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="vascular-atlas">
<h2>Vascular atlas<a class="headerlink" href="#vascular-atlas" 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="_autosummary/hemolearn.atlas.fetch_basc_vascular_atlas.html#hemolearn.atlas.fetch_basc_vascular_atlas" title="hemolearn.atlas.fetch_basc_vascular_atlas"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hemolearn.atlas.fetch_basc_vascular_atlas</span></code></a>([…])</p></td>
<td><p>Fetch the BASC brain atlas given its resolution.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/hemolearn.atlas.fetch_harvard_vascular_atlas.html#hemolearn.atlas.fetch_harvard_vascular_atlas" title="hemolearn.atlas.fetch_harvard_vascular_atlas"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hemolearn.atlas.fetch_harvard_vascular_atlas</span></code></a>([…])</p></td>
<td><p>Fetch the Harvard-Oxford brain atlas given its resolution.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/hemolearn.atlas.fetch_aal_vascular_atlas.html#hemolearn.atlas.fetch_aal_vascular_atlas" title="hemolearn.atlas.fetch_aal_vascular_atlas"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hemolearn.atlas.fetch_aal_vascular_atlas</span></code></a>([…])</p></td>
<td><p>Fetch the AAL brain atlas given its resolution.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/hemolearn.atlas.fetch_aal3_vascular_atlas.html#hemolearn.atlas.fetch_aal3_vascular_atlas" title="hemolearn.atlas.fetch_aal3_vascular_atlas"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hemolearn.atlas.fetch_aal3_vascular_atlas</span></code></a>([…])</p></td>
<td><p>Fetch the AAL3 brain atlas given its resolution.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="generating-synthesis-data">
<h2>Generating synthesis data<a class="headerlink" href="#generating-synthesis-data" 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="_autosummary/hemolearn.simulated_data.simulated_data.html#hemolearn.simulated_data.simulated_data" title="hemolearn.simulated_data.simulated_data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hemolearn.simulated_data.simulated_data</span></code></a>([…])</p></td>
<td><p>Generate simulated BOLD data with its temporal components z and the corresponding maps u.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="convolution-functions">
<h2>Convolution functions<a class="headerlink" href="#convolution-functions" 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="_autosummary/hemolearn.convolution.make_toeplitz.html#hemolearn.convolution.make_toeplitz" title="hemolearn.convolution.make_toeplitz"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hemolearn.convolution.make_toeplitz</span></code></a>(v, …)</p></td>
<td><p>Make Toeplitz matrix from given kernel to perform valid convolution.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="haemodynamic-response-function-models">
<h2>Haemodynamic Response Function models<a class="headerlink" href="#haemodynamic-response-function-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="_autosummary/hemolearn.hrf_model.hrf_2_basis.html#hemolearn.hrf_model.hrf_2_basis" title="hemolearn.hrf_model.hrf_2_basis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hemolearn.hrf_model.hrf_2_basis</span></code></a>(t_r, …)</p></td>
<td><p>Double gamma HRF 2 basis function.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/hemolearn.hrf_model.hrf_3_basis.html#hemolearn.hrf_model.hrf_3_basis" title="hemolearn.hrf_model.hrf_3_basis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hemolearn.hrf_model.hrf_3_basis</span></code></a>(t_r, …)</p></td>
<td><p>Double gamma HRF 3 basis function.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/hemolearn.hrf_model.scaled_hrf.html#hemolearn.hrf_model.scaled_hrf" title="hemolearn.hrf_model.scaled_hrf"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hemolearn.hrf_model.scaled_hrf</span></code></a>(delta, t_r[, …])</p></td>
<td><p>Double gamma scaled HRF.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="plotting-functions">
<h2>Plotting functions<a class="headerlink" href="#plotting-functions" 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="_autosummary/hemolearn.plotting.plot_vascular_map.html#hemolearn.plotting.plot_vascular_map" title="hemolearn.plotting.plot_vascular_map"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hemolearn.plotting.plot_vascular_map</span></code></a>(a_img)</p></td>
<td><p>Plot vascular map.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/hemolearn.plotting.plot_spatial_maps.html#hemolearn.plotting.plot_spatial_maps" title="hemolearn.plotting.plot_spatial_maps"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hemolearn.plotting.plot_spatial_maps</span></code></a>(u_img)</p></td>
<td><p>Plot spatial maps.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/hemolearn.plotting.plot_temporal_activations.html#hemolearn.plotting.plot_temporal_activations" title="hemolearn.plotting.plot_temporal_activations"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hemolearn.plotting.plot_temporal_activations</span></code></a>(z, t_r)</p></td>
<td><p>Plot temporal activations.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="utilities-functions">
<h2>Utilities functions<a class="headerlink" href="#utilities-functions" 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="_autosummary/hemolearn.utils.sort_by_expl_var.html#hemolearn.utils.sort_by_expl_var" title="hemolearn.utils.sort_by_expl_var"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hemolearn.utils.sort_by_expl_var</span></code></a>(u, z, v, …)</p></td>
<td><p>Sorted the temporal the spatial maps and the associated activation by explained variance.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/hemolearn.utils.fwhm.html#hemolearn.utils.fwhm" title="hemolearn.utils.fwhm"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hemolearn.utils.fwhm</span></code></a>(t_r, hrf)</p></td>
<td><p>Return the full width at half maximum of the HRF.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/hemolearn.utils.tp.html#hemolearn.utils.tp" title="hemolearn.utils.tp"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hemolearn.utils.tp</span></code></a>(t_r, hrf)</p></td>
<td><p>Return time to peak oh the signal of the HRF.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
<footer class="footer">
<div class="container">
<p class="pull-right">
<a href="#">Back to top</a>
</p>
<p>
© Copyright 2021, Hamza Cherkaoui.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.0.<br/>
</p>
</div>
</footer>
</body>
</html>