/
nistats_migration.html
388 lines (350 loc) · 19.2 KB
/
nistats_migration.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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta property="og:title" content="A Quick Guide to Migrating Nistats Code to Nilearn" />
<meta property="og:type" content="website" />
<meta property="og:url" content="https://nilearn.github.io/nistats_migration.html" />
<meta property="og:site_name" content="Nilearn" />
<meta property="og:description" content="A quick guide to changing your Nistats imports to work in Nilearn Datasets: Imports from nistats.datasets are in nilearn.datasets Hemodynamic Models: Imports from nistats.hemodynamic_models are in ..." />
<meta property="og:image" content="https://nilearn.github.io/_static/nilearn-logo.png" />
<meta property="og:image:alt" content="Nilearn" />
<title>Nilearn: Statistical Analysis for NeuroImaging in Python — Machine learning for NeuroImaging</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/nature.css" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css" />
<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/doctools.js"></script>
<script src="_static/clipboard.min.js"></script>
<script src="_static/copybutton.js"></script>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="People" href="authors.html" />
<link rel="prev" title="<no title>" href="index.html" />
<meta content="True" name="HandheldFriendly">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0">
<meta name="keywords" content="nilearn, neuroimaging, python, neuroscience, machinelearning">
<script type="text/javascript">
function updateTopMenuPosition(height, width) {
if($(window).scrollTop() > height && $(window).outerWidth() > 1024) {
//begin to scroll
$('.related-wrapper').css("z-index", 1000);
$('.related-wrapper').css("position", "sticky");
$('.related-wrapper').css("top", 0);
$('.related-wrapper').css("width", width)
} else {
//lock it back into place
$('.related-wrapper').css("position", "relative");
$('.related-wrapper').css("top", 0)
}
}
$(function() {
var banner_height = $('#logo-banner').outerHeight();
var banner_width = $('#logo-banner').outerWidth();
var width = $('.related-wrapper').css("height", $('.related').outerHeight());
updateTopMenuPosition(banner_height, width);
$(window).scroll(function(event) {
updateTopMenuPosition(banner_height, width)
});
$(window).resize(function(event) {
var banner_width = $('#logo-banner').outerWidth();
var menu_height = $('.related').outerHeight();
$('.related').css("width", banner_width);
$('.related-wrapper').css("height", menu_height);
updateTopMenuPosition(banner_height, width)
})
});
</script>
<script type="text/javascript">
function updateSideBarPosition(top, offset, sections) {
var pos = $(window).scrollTop();
// Lock the table of content to a fixed position once we scroll enough
var topShift = 2 * offset;
if(pos > top + topShift + 1) {
// begin to scroll with sticky menu bar
var topShift = -topShift + 1;
if ($(window).outerWidth() < 1024) {
// compensate top menu that disappears
topShift -= offset + 1
}
$('.sphinxsidebarwrapper').css("position", "fixed");
$('.sphinxsidebarwrapper').css("top", topShift)
}
else {
//lock it back into place
$('.sphinxsidebarwrapper').css("position", "relative");
$('.sphinxsidebarwrapper').css("top",0)
}
// Highlight the current section
i = 0;
current_section = 0;
$('a.internal').removeClass('active');
for(i in sections) {
if(sections[i] > pos) {
break
}
if($('a.internal[href$="' + i + '"]').is(':visible')){
current_section = i
}
}
$('a.internal[href$="' + current_section + '"]').addClass('active');
$('a.internal[href$="' + current_section + '"]').parent().addClass('active')
}
$(function () {
// Lock the table of content to a fixed position once we scroll enough
var tocOffset = $('.related-wrapper').outerHeight();
var marginTop = parseFloat($('.sphinxsidebarwrapper').css('margin-top').replace(/auto/, 0));
var top = $('.sphinxsidebarwrapper').offset().top - marginTop;
sections = {};
url = document.URL.replace(/#.*$/, "");
// Grab positions of our sections
$('.headerlink').each(function(){
sections[this.href.replace(url, '')] = $(this).offset().top - 50
});
updateSideBarPosition(top, tocOffset, sections);
$(window).scroll(function(event) {
updateSideBarPosition(top, tocOffset, sections)
});
$(window).resize(function(event) {
tocOffset = $('.related-wrapper').outerHeight();
updateSideBarPosition(top, tocOffset, sections)
});
});
</script>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-41920728-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head><body>
<div id="logo-banner">
<div class="logo">
<a href="index.html">
<img src="_static/nilearn-logo.png" alt="Nilearn logo" border="0" />
</a>
</div>
<!-- A tag cloud to make it easy for people to find what they are
looking for -->
<div class="tags">
<ul>
<li>
<big><a href="auto_examples/decoding/plot_haxby_anova_svm.html">SVM</a></big>
</li>
<li>
<small><a href="connectivity/parcellating.html">Ward
clustering</a></small>
</li>
<li>
<a href="decoding/searchlight.html">Searchlight</a>
</li>
<li>
<big><a href="connectivity/resting_state_networks.html">ICA</a></big>
</li>
<li>
<a href="manipulating_images/data_preparation.html">Nifti IO</a>
</li>
<li>
<a href="modules/reference.html#module-nilearn.datasets">Datasets</a>
</li>
</ul>
</div>
<div class="banner">
<h1>Nilearn:</h1>
<h2>Statistics for NeuroImaging in Python</h2>
</div>
<div class="search_form">
<div class="gcse-search" id="cse" style="width: 100%;"></div>
<script>
(function() {
var cx = '017289614950330089114:elrt9qoutrq';
var gcse = document.createElement('script');
gcse.type = 'text/javascript';
gcse.async = true;
gcse.src = 'https://cse.google.com/cse.js?cx=' + cx;
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(gcse, s);
})();
</script>
</div>
</div>
<div class=related-wrapper>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="py-modindex.html" title="Python Module Index"
>modules</a></li>
<li class="right" >
<a href="authors.html" title="People"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="<no title>"
accesskey="P">previous</a> |</li>
<li><a href="index.html">Nilearn Home</a> | </li>
<li><a href="user_guide.html">User Guide</a> | </li>
<li><a href="auto_examples/index.html">Examples</a> | </li>
<li><a href="modules/reference.html">Reference</a> | </li>
<li id="navbar-about"><a href="authors.html">About</a>| </li>
<li><a href="glossary.html">Glossary</a>| </li>
<li><a href="bibliography.html">Bibliography</a>| </li>
<li id="navbar-ecosystem"><a href="http://www.nipy.org/">Nipy ecosystem</a></li>
<li class="nav-item nav-item-this"><a href="">Nilearn: Statistical Analysis for NeuroImaging in Python</a></li>
</ul>
</div>
</div>
<div class="stable-banner">
This is the <em>stable</em> documentation for the latest release of Nilearn,
the current development version is available <a href="https://nilearn.github.io/dev/index.html">here</a>.
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="a-quick-guide-to-migrating-nistats-code-to-nilearn">
<span id="nistats-migration"></span><h1>A Quick Guide to Migrating Nistats Code to Nilearn<a class="headerlink" href="#a-quick-guide-to-migrating-nistats-code-to-nilearn" title="Permalink to this headline">¶</a></h1>
<p>A quick guide to changing your Nistats imports to work in Nilearn</p>
<div class="section" id="datasets">
<h2>Datasets<a class="headerlink" href="#datasets" title="Permalink to this headline">¶</a></h2>
<p>Imports from
<a class="reference external" href="https://nistats.github.io/modules/reference.html#module-nistats.datasets">nistats.datasets</a>
are in <a class="reference internal" href="modules/reference.html#module-nilearn.datasets" title="nilearn.datasets"><code class="xref py py-mod docutils literal notranslate"><span class="pre">nilearn.datasets</span></code></a></p>
</div>
<div class="section" id="hemodynamic-models">
<h2>Hemodynamic Models<a class="headerlink" href="#hemodynamic-models" title="Permalink to this headline">¶</a></h2>
<p>Imports from
<a class="reference external" href="https://nistats.github.io/modules/reference.html#module-nistats.hemodynamic_models">nistats.hemodynamic_models</a>
are in <a class="reference internal" href="modules/reference.html#module-nilearn.glm.first_level" title="nilearn.glm.first_level"><code class="xref py py-mod docutils literal notranslate"><span class="pre">nilearn.glm.first_level</span></code></a></p>
</div>
<div class="section" id="design-matrix">
<h2>Design matrix<a class="headerlink" href="#design-matrix" title="Permalink to this headline">¶</a></h2>
<p>Most imports from
<a class="reference external" href="https://nistats.github.io/modules/reference.html#module-nistats.design_matrix">nistats.design_matrix</a>
are in <a class="reference internal" href="modules/reference.html#module-nilearn.glm.first_level" title="nilearn.glm.first_level"><code class="xref py py-mod docutils literal notranslate"><span class="pre">nilearn.glm.first_level</span></code></a></p>
<p><a class="reference external" href="https://nistats.github.io/modules/generated/nistats.design_matrix.make_second_level_design_matrix.html#nistats.design_matrix.make_second_level_design_matrix">nistats.design_matrix.make_second_level_design_matrix</a>
is in <a class="reference internal" href="modules/reference.html#module-nilearn.glm.second_level" title="nilearn.glm.second_level"><code class="xref py py-mod docutils literal notranslate"><span class="pre">nilearn.glm.second_level</span></code></a></p>
</div>
<div class="section" id="experimental-paradigm">
<h2>Experimental Paradigm<a class="headerlink" href="#experimental-paradigm" title="Permalink to this headline">¶</a></h2>
<p>Imports from
<a class="reference external" href="https://nistats.github.io/modules/reference.html#module-nistats.experimental_paradigm">nistats.experimental_paradigm</a> are in <a class="reference internal" href="modules/reference.html#module-nilearn.glm.first_level" title="nilearn.glm.first_level"><code class="xref py py-mod docutils literal notranslate"><span class="pre">nilearn.glm.first_level</span></code></a></p>
</div>
<div class="section" id="statistical-models">
<h2>Statistical Models<a class="headerlink" href="#statistical-models" title="Permalink to this headline">¶</a></h2>
<p>Imports from
<a class="reference external" href="https://nistats.github.io/modules/reference.html#module-nistats.model">nistats.model</a>
are now in <a class="reference internal" href="modules/reference.html#module-nilearn.glm" title="nilearn.glm"><code class="xref py py-mod docutils literal notranslate"><span class="pre">nilearn.glm</span></code></a></p>
</div>
<div class="section" id="regression-models">
<h2>Regression Models<a class="headerlink" href="#regression-models" title="Permalink to this headline">¶</a></h2>
<p>Imports from
<a class="reference external" href="https://nistats.github.io/modules/reference.html#module-nistats.regression">nistats.regression</a>
are in <a class="reference internal" href="modules/reference.html#module-nilearn.glm" title="nilearn.glm"><code class="xref py py-mod docutils literal notranslate"><span class="pre">nilearn.glm</span></code></a></p>
</div>
<div class="section" id="first-level-model">
<h2>First Level Model<a class="headerlink" href="#first-level-model" title="Permalink to this headline">¶</a></h2>
<p>Imports from
<a class="reference external" href="https://nistats.github.io/modules/reference.html#module-nistats.first_level">nistats.first_level</a>
are in <a class="reference internal" href="modules/reference.html#module-nilearn.glm.first_level" title="nilearn.glm.first_level"><code class="xref py py-mod docutils literal notranslate"><span class="pre">nilearn.glm.first_level</span></code></a></p>
</div>
<div class="section" id="second-level-model">
<h2>Second Level Model<a class="headerlink" href="#second-level-model" title="Permalink to this headline">¶</a></h2>
<p>Imports from
<a class="reference external" href="https://nistats.github.io/modules/reference.html#module-nistats.second_level">nistats.second_level</a>
are in <a class="reference internal" href="modules/reference.html#module-nilearn.glm.second_level" title="nilearn.glm.second_level"><code class="xref py py-mod docutils literal notranslate"><span class="pre">nilearn.glm.second_level</span></code></a></p>
</div>
<div class="section" id="contrasts">
<h2>Contrasts<a class="headerlink" href="#contrasts" title="Permalink to this headline">¶</a></h2>
<p>imports from
<a class="reference external" href="https://nistats.github.io/modules/reference.html#module-nistats.contrasts">nistats.contrasts</a>
are in <a class="reference internal" href="modules/reference.html#module-nilearn.glm" title="nilearn.glm"><code class="xref py py-mod docutils literal notranslate"><span class="pre">nilearn.glm</span></code></a></p>
</div>
<div class="section" id="thresholding-maps">
<h2>Thresholding Maps<a class="headerlink" href="#thresholding-maps" title="Permalink to this headline">¶</a></h2>
<p>Imports from
<a class="reference external" href="https://nistats.github.io/modules/reference.html#module-nistats.thresholding">nistats.thresholding</a>
are in <a class="reference internal" href="modules/reference.html#module-nilearn.glm" title="nilearn.glm"><code class="xref py py-mod docutils literal notranslate"><span class="pre">nilearn.glm</span></code></a></p>
</div>
<div class="section" id="report-plotting-functions">
<h2>Report plotting functions<a class="headerlink" href="#report-plotting-functions" title="Permalink to this headline">¶</a></h2>
<p>Imports from
<a class="reference external" href="https://nistats.github.io/modules/reference.html#module-nistats.reporting">nistats.reporting</a>
are in <a class="reference internal" href="modules/reference.html#module-nilearn.reporting" title="nilearn.reporting"><code class="xref py py-mod docutils literal notranslate"><span class="pre">nilearn.reporting</span></code></a> or <a class="reference internal" href="modules/reference.html#module-nilearn.plotting" title="nilearn.plotting"><code class="xref py py-mod docutils literal notranslate"><span class="pre">nilearn.plotting</span></code></a></p>
</div>
<div class="section" id="utility-functions">
<h2>Utility functions<a class="headerlink" href="#utility-functions" title="Permalink to this headline">¶</a></h2>
<p>Imports from
<a class="reference external" href="https://nistats.github.io/modules/reference.html#module-nistats.utils">nistats.utils</a>
are in <cite>nilearn._utils</cite> and are usually meant for development purposes.</p>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4> Giving credit </h4>
<ul class="simple">
<li><p>Please consider <a href="authors.html#citing">citing the
papers</a>.</p></li>
</ul>
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">A Quick Guide to Migrating Nistats Code to Nilearn</a><ul>
<li><a class="reference internal" href="#datasets">Datasets</a></li>
<li><a class="reference internal" href="#hemodynamic-models">Hemodynamic Models</a></li>
<li><a class="reference internal" href="#design-matrix">Design matrix</a></li>
<li><a class="reference internal" href="#experimental-paradigm">Experimental Paradigm</a></li>
<li><a class="reference internal" href="#statistical-models">Statistical Models</a></li>
<li><a class="reference internal" href="#regression-models">Regression Models</a></li>
<li><a class="reference internal" href="#first-level-model">First Level Model</a></li>
<li><a class="reference internal" href="#second-level-model">Second Level Model</a></li>
<li><a class="reference internal" href="#contrasts">Contrasts</a></li>
<li><a class="reference internal" href="#thresholding-maps">Thresholding Maps</a></li>
<li><a class="reference internal" href="#report-plotting-functions">Report plotting functions</a></li>
<li><a class="reference internal" href="#utility-functions">Utility functions</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter"><no title></a></p>
<h4>Next topic</h4>
<p class="topless"><a href="authors.html"
title="next chapter">People</a></p>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© The nilearn developers 2010-2022.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 4.0.2.
<span style="padding-left: 5ex;">
<a href="_sources/nistats_migration.rst.txt"
rel="nofollow">Show this page source</a>
</span>
</div>
</body>
</html>