-
Notifications
You must be signed in to change notification settings - Fork 12
/
0.3.0.html
381 lines (343 loc) · 23.4 KB
/
0.3.0.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
<!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="0.3.0" />
<meta property="og:type" content="website" />
<meta property="og:url" content="https://nilearn.github.io/changes/0.3.0.html" />
<meta property="og:site_name" content="Nilearn" />
<meta property="og:description" content="Released April 2017 In addition, more details of this release are listed below. Please checkout in 0.3.0 beta release section for minimum version support of dependencies, latest updates, highlights..." />
<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" />
<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><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="id1">
<h1>0.3.0<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h1>
<p><strong>Released April 2017</strong></p>
<p>In addition, more details of this release are listed below.
Please checkout in <strong>0.3.0 beta</strong> release section for minimum version
support of dependencies, latest updates, highlights, changelog and enhancements.</p>
<div class="section" id="changes">
<h2>Changes<a class="headerlink" href="#changes" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p>Function <a class="reference internal" href="../modules/generated/nilearn.plotting.find_cut_slices.html#nilearn.plotting.find_cut_slices" title="nilearn.plotting.find_cut_slices"><code class="xref py py-func docutils literal notranslate"><span class="pre">find_cut_slices</span></code></a> now supports to accept <a class="reference external" href="https://nipy.org/nibabel/reference/nibabel.nifti1.html#nibabel.nifti1.Nifti1Image" title="(in NiBabel v3.2.1+100.g9fdf5e3e)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Nifti1Image</span></code></a> as an input for argument <code class="docutils literal notranslate"><span class="pre">img</span></code>.</p></li>
<li><p>Helper functions <code class="docutils literal notranslate"><span class="pre">_get_mask_volume</span></code> and <code class="docutils literal notranslate"><span class="pre">_adjust_screening_percentile</span></code> are now moved to <code class="docutils literal notranslate"><span class="pre">param_validation</span></code> file in utilities module to be used in common with Decoder object.</p></li>
</ul>
</div>
<div class="section" id="fixes">
<h2>Fixes<a class="headerlink" href="#fixes" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p>Fix bug uncompressing tar files with datasets fetcher.</p></li>
<li><p>Fixed bunch of CircleCI documentation build failures.</p></li>
<li><p>Fixed deprecations <code class="docutils literal notranslate"><span class="pre">set_axis_bgcolor</span></code> related to matplotlib in plotting functions.</p></li>
<li><p>Fixed bug related to not accepting a list of arrays as an input to unmask, in <a class="reference internal" href="../modules/reference.html#module-nilearn.masking" title="nilearn.masking"><code class="xref py py-mod docutils literal notranslate"><span class="pre">nilearn.masking</span></code></a> module.</p></li>
</ul>
</div>
<div class="section" id="enhancements">
<h2>Enhancements<a class="headerlink" href="#enhancements" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="../glossary.html#term-ANOVA"><span class="xref std std-term">ANOVA</span></a> <a class="reference internal" href="../glossary.html#term-SVM"><span class="xref std std-term">SVM</span></a> example on Haxby datasets <code class="docutils literal notranslate"><span class="pre">plot_haxby_anova_svm</span></code> in Decoding section now uses <code class="docutils literal notranslate"><span class="pre">SelectPercentile</span></code> to select <a class="reference internal" href="../glossary.html#term-voxel"><span class="xref std std-term">voxels</span></a> rather than <code class="docutils literal notranslate"><span class="pre">SelectKBest</span></code>.</p></li>
<li><p>New function <code class="docutils literal notranslate"><span class="pre">fast_svd</span></code> implementation in base decomposition module to automatically switch between randomized and lapack SVD (heuristic of <code class="docutils literal notranslate"><span class="pre">scikit-learn</span></code>).</p></li>
</ul>
</div>
</div>
<div class="section" id="beta">
<h1>0.3.0 beta<a class="headerlink" href="#beta" title="Permalink to this headline">¶</a></h1>
<p><strong>Released February 2017</strong></p>
<p>To install the beta version, use:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="o">--</span><span class="n">upgrade</span> <span class="o">--</span><span class="n">pre</span> <span class="n">nilearn</span>
</pre></div>
</div>
<div class="section" id="highlights">
<h2>Highlights<a class="headerlink" href="#highlights" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p>Simple surface plotting.</p></li>
<li><p>A function to break a parcellation into its connected components.</p></li>
<li><p><strong>Dropped support for scikit-learn older than 0.14.1</strong> Minimum supported version is now <code class="docutils literal notranslate"><span class="pre">0.14.1</span></code>.</p></li>
<li><p><strong>Dropped support for Python 2.6</strong></p></li>
<li><p>Minimum required version of <code class="docutils literal notranslate"><span class="pre">NiBabel</span></code> is now <code class="docutils literal notranslate"><span class="pre">1.2.0</span></code>, to support loading annotated data with freesurfer.</p></li>
</ul>
</div>
<div class="section" id="id2">
<h2>Changes<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p>A helper function <code class="docutils literal notranslate"><span class="pre">_safe_get_data</span></code> as a nilearn utility now safely removes <code class="docutils literal notranslate"><span class="pre">NaN</span></code> values in the images with argument <code class="docutils literal notranslate"><span class="pre">ensure_finite=True</span></code>.</p></li>
<li><p>Functions <a class="reference internal" href="../modules/generated/nilearn.connectome.cov_to_corr.html#nilearn.connectome.cov_to_corr" title="nilearn.connectome.cov_to_corr"><code class="xref py py-func docutils literal notranslate"><span class="pre">cov_to_corr</span></code></a> and <a class="reference internal" href="../modules/generated/nilearn.connectome.prec_to_partial.html#nilearn.connectome.prec_to_partial" title="nilearn.connectome.prec_to_partial"><code class="xref py py-func docutils literal notranslate"><span class="pre">prec_to_partial</span></code></a> can now be used.</p></li>
</ul>
</div>
<div class="section" id="id3">
<h2>Fixes<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p>Fix colormap issue with <code class="docutils literal notranslate"><span class="pre">colorbar=True</span></code> when using qualitative colormaps. Fixed in according with changes of <code class="docutils literal notranslate"><span class="pre">matplotlib</span> <span class="pre">2.0</span></code> fixes.</p></li>
<li><p>Fix plotting functions to work with <code class="docutils literal notranslate"><span class="pre">NaN</span></code> values in the images.</p></li>
<li><p>Fix bug related get <code class="docutils literal notranslate"><span class="pre">dtype</span></code> of the images with <code class="docutils literal notranslate"><span class="pre">nibabel</span> <span class="pre">get_data()</span></code>.</p></li>
<li><p>Fix bug in function <a class="reference internal" href="../modules/generated/nilearn.image.clean_img.html#nilearn.image.clean_img" title="nilearn.image.clean_img"><code class="xref py py-func docutils literal notranslate"><span class="pre">clean_img</span></code></a>.</p></li>
</ul>
</div>
<div class="section" id="id4">
<h2>Enhancements<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p>New function <a class="reference internal" href="../modules/generated/nilearn.regions.connected_label_regions.html#nilearn.regions.connected_label_regions" title="nilearn.regions.connected_label_regions"><code class="xref py py-func docutils literal notranslate"><span class="pre">connected_label_regions</span></code></a> to extract the connected components represented as same label to regions apart with each region labelled as unique label.</p></li>
<li><p>New plotting modules for surface plotting visualization. <code class="docutils literal notranslate"><span class="pre">Matplotlib</span></code> with version higher <code class="docutils literal notranslate"><span class="pre">1.3.1</span></code> is required for plotting surface data using these functions.</p></li>
<li><p>Function <a class="reference internal" href="../modules/generated/nilearn.plotting.plot_surf.html#nilearn.plotting.plot_surf" title="nilearn.plotting.plot_surf"><code class="xref py py-func docutils literal notranslate"><span class="pre">plot_surf</span></code></a> can be used for plotting surfaces mesh data with optional background.</p></li>
<li><p>Function <a class="reference internal" href="../modules/generated/nilearn.plotting.plot_surf_stat_map.html#nilearn.plotting.plot_surf_stat_map" title="nilearn.plotting.plot_surf_stat_map"><code class="xref py py-func docutils literal notranslate"><span class="pre">plot_surf_stat_map</span></code></a> can be used for plotting statistical maps on a brain surface with optional background.</p></li>
<li><p>Function <a class="reference internal" href="../modules/generated/nilearn.plotting.plot_surf_roi.html#nilearn.plotting.plot_surf_roi" title="nilearn.plotting.plot_surf_roi"><code class="xref py py-func docutils literal notranslate"><span class="pre">plot_surf_roi</span></code></a> can be used for plotting statistical maps rois onto brain surface.</p></li>
<li><p>Function <code class="docutils literal notranslate"><span class="pre">nilearn.datasets.fetch_surf_fsaverage5</span></code> can be used for surface data object to be as background map for the above plotting functions.</p></li>
<li><p>New function <a class="reference internal" href="../modules/generated/nilearn.datasets.fetch_atlas_surf_destrieux.html#nilearn.datasets.fetch_atlas_surf_destrieux" title="nilearn.datasets.fetch_atlas_surf_destrieux"><code class="xref py py-func docutils literal notranslate"><span class="pre">fetch_atlas_surf_destrieux</span></code></a> can give you Destrieux et. al 2010 cortical atlas in <code class="docutils literal notranslate"><span class="pre">fsaverage5</span></code> surface space.</p></li>
<li><p>New function <a class="reference internal" href="../modules/generated/nilearn.datasets.fetch_surf_nki_enhanced.html#nilearn.datasets.fetch_surf_nki_enhanced" title="nilearn.datasets.fetch_surf_nki_enhanced"><code class="xref py py-func docutils literal notranslate"><span class="pre">fetch_surf_nki_enhanced</span></code></a> gives you resting state data preprocessed and projected to <code class="docutils literal notranslate"><span class="pre">fsaverage5</span></code> surface space.</p></li>
<li><p>Two good examples in plotting gallery shows how to fetch atlas and NKI data and used for plotting on brain surface.</p></li>
<li><p>New function <a class="reference internal" href="../modules/generated/nilearn.surface.load_surf_mesh.html#nilearn.surface.load_surf_mesh" title="nilearn.surface.load_surf_mesh"><code class="xref py py-func docutils literal notranslate"><span class="pre">load_surf_mesh</span></code></a> in <code class="docutils literal notranslate"><span class="pre">surf_plotting</span></code> module for loading surface mesh data into two arrays, containing <code class="docutils literal notranslate"><span class="pre">(x,</span> <span class="pre">y,</span> <span class="pre">z)</span></code> coordinates for mesh vertices and indices of mesh faces.</p></li>
<li><p>New function <a class="reference internal" href="../modules/generated/nilearn.surface.load_surf_data.html#nilearn.surface.load_surf_data" title="nilearn.surface.load_surf_data"><code class="xref py py-func docutils literal notranslate"><span class="pre">load_surf_data</span></code></a> in <code class="docutils literal notranslate"><span class="pre">surf_plotting</span></code> module for loading data of numpy array to represented on a surface mesh.</p></li>
<li><p>Add fetcher for Allen et al. 2011 RSN atlas in <a class="reference internal" href="../modules/generated/nilearn.datasets.fetch_atlas_allen_2011.html#nilearn.datasets.fetch_atlas_allen_2011" title="nilearn.datasets.fetch_atlas_allen_2011"><code class="xref py py-func docutils literal notranslate"><span class="pre">fetch_atlas_allen_2011</span></code></a>.</p></li>
<li><p>Function <code class="docutils literal notranslate"><span class="pre">nilearn.datasets.fetch_cobre</span></code> is now updated to new light release of COBRE data (schizophrenia).</p></li>
<li><p>A new example to show how to extract regions on labels image in example section manipulating images.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">coveralls</span></code> is replaced with <code class="docutils literal notranslate"><span class="pre">codecov</span></code>.</p></li>
<li><p>Upgraded to <code class="docutils literal notranslate"><span class="pre">Sphinx</span></code> version <code class="docutils literal notranslate"><span class="pre">0.1.7</span></code>.</p></li>
<li><p>Extensive plotting example shows how to use contours and filled contours on glass brain.</p></li>
</ul>
</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="#">0.3.0</a><ul>
<li><a class="reference internal" href="#changes">Changes</a></li>
<li><a class="reference internal" href="#fixes">Fixes</a></li>
<li><a class="reference internal" href="#enhancements">Enhancements</a></li>
</ul>
</li>
<li><a class="reference internal" href="#beta">0.3.0 beta</a><ul>
<li><a class="reference internal" href="#highlights">Highlights</a></li>
<li><a class="reference internal" href="#id2">Changes</a></li>
<li><a class="reference internal" href="#id3">Fixes</a></li>
<li><a class="reference internal" href="#id4">Enhancements</a></li>
</ul>
</li>
</ul>
<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/changes/0.3.0.rst.txt"
rel="nofollow">Show this page source</a>
</span>
</div>
</body>
</html>