User guide

Note

You can download the user guide and examples for offline viewing.

This user guide is especially directed towards grad students with a background in computer science, machine learning, computational biology or neuroscience. However, less or more advanced readers can also find interesting pieces of information throughout the guide.

Table of contents

• 1. Introduction
• 2. What is nilearn?
• 3. Using nilearn for the first time
  • 3.1. First steps with nilearn
  • 3.2. Learning with the API references
  • 3.3. Learning with examples
  • 3.4. Finding help
• 4. Machine learning applications to Neuroimaging
  • 4.1. References
• 5. Decoding and MVPA: predicting from brain images
  • 5.1. An introduction to decoding
    • 5.1.1. Loading and preparing the data
      • 5.1.1.1. The Haxby 2001 experiment
      • 5.1.1.2. Loading the data into nilearn
    • 5.1.2. Performing a simple decoding analysis
      • 5.1.2.1. A few definitions
      • 5.1.2.2. A first estimator
      • 5.1.2.3. Decoding made easy
      • 5.1.2.4. Measuring prediction performance
        • 5.1.2.4.1. Cross-validation
        • 5.1.2.4.2. Choosing a good cross-validation strategy
        • 5.1.2.4.3. Choice of the prediction accuracy measure
        • 5.1.2.4.4. Prediction accuracy at chance using simple strategies
      • 5.1.2.5. Visualizing the decoder’s weights
    • 5.1.3. Decoding without a mask: Anova-SVM
      • 5.1.3.1. Dimension reduction with feature selection
      • 5.1.3.2. Visualizing the results
      • 5.1.3.3. References
  • 5.2. Choosing the right predictive model for neuroimaging
    • 5.2.1. Predictions: regression, classification and multi-class
      • 5.2.1.1. Regression
      • 5.2.1.2. Classification: two classes or multi-class
    • 5.2.2. Different linear models
    • 5.2.3. Setting estimator parameters
    • 5.2.4. Bagging several models
    • 5.2.5. References
  • 5.3. FREM: fast ensembling of regularized models for robust decoding
    • 5.3.1. FREM pipeline
    • 5.3.2. Empirical comparisons
      • 5.3.2.1. Decoding performance increase on Haxby dataset
      • 5.3.2.2. Spatial regularization of decoding maps on mixed gambles study
    • 5.3.3. References
  • 5.4. SpaceNet: decoding with spatial structure for better maps
    • 5.4.1. The SpaceNet decoder
    • 5.4.2. Related example
    • 5.4.3. References
  • 5.5. Searchlight : finding voxels containing information
    • 5.5.1. Principle of the Searchlight
    • 5.5.2. Preparing the data
      • 5.5.2.1. Masking
    • 5.5.3. Setting up the searchlight
      • 5.5.3.1. Classifier
      • 5.5.3.2. Score function
      • 5.5.3.3. Cross validation
      • 5.5.3.4. Sphere radius
    • 5.5.4. Visualization
      • 5.5.4.1. Searchlight
      • 5.5.4.2. Comparing to massively univariate analysis: F_score or SPM
    • 5.5.5. References
  • 5.6. Running scikit-learn functions for more control on the analysis
    • 5.6.1. Performing decoding with scikit-learn
      • 5.6.1.1. Using scikit-learn estimators
      • 5.6.1.2. Cross-validation with scikit-learn
      • 5.6.1.3. Measuring the chance level
    • 5.6.2. Going further with scikit-learn
      • 5.6.2.1. Decoding without a mask: Anova-SVM using scikit-learn
      • 5.6.2.2. Using any other model in the pipeline
    • 5.6.3. Setting estimator parameters
• 6. Functional connectivity and resting state
  • 6.1. Extracting times series to build a functional connectome
    • 6.1.1. Time-series from a brain parcellation or “MaxProb” atlas
      • 6.1.1.1. Brain parcellations
      • 6.1.1.2. Extracting signals on a parcellation
    • 6.1.2. Time-series from a probabilistic atlas
      • 6.1.2.1. Probabilistic atlases
      • 6.1.2.2. Extracting signals from a probabilistic atlas
    • 6.1.3. A functional connectome: a graph of interactions
    • 6.1.4. A functional connectome: extracting coordinates of regions
      • 6.1.4.1. References
  • 6.2. Connectome extraction: inverse covariance for direct connections
    • 6.2.1. Sparse inverse covariance for functional connectomes
    • 6.2.2. Sparse inverse covariance on multiple subjects
    • 6.2.3. Comparing the different approaches on simulated data
    • 6.2.4. Linking total and direct interactions at the group level
      • 6.2.4.1. References
  • 6.3. Extracting functional brain networks: ICA and related
    • 6.3.1. Multi-subject ICA: CanICA
      • 6.3.1.1. Objective
      • 6.3.1.2. Fitting CanICA model with nilearn
      • 6.3.1.3. Visualizing results
      • 6.3.1.4. Interpreting such components
    • 6.3.2. An alternative to ICA: Dictionary learning
      • 6.3.2.1. References
  • 6.4. Region Extraction for better brain parcellations
    • 6.4.1. Fetching movie-watching based functional datasets
    • 6.4.2. Brain maps using Dictionary learning
    • 6.4.3. Visualization of Dictionary learning maps
    • 6.4.4. Region Extraction with Dictionary learning maps
    • 6.4.5. Visualization of Region Extraction results
    • 6.4.6. Computing functional connectivity matrices
    • 6.4.7. Visualization of functional connectivity matrices
    • 6.4.8. Validating results
      • 6.4.8.1. References
  • 6.5. Clustering to parcellate the brain in regions
    • 6.5.1. Data loading: movie-watching data
    • 6.5.2. Applying clustering
    • 6.5.3. Using and visualizing the resulting parcellation
      • 6.5.3.1. Visualizing the parcellation
      • 6.5.3.2. Compressed representation
      • 6.5.3.3. References
• 7. Plotting brain images
  • 7.1. Different plotting functions
  • 7.2. Different display modes
  • 7.3. Available Colormaps
  • 7.4. Adding overlays, edges, contours, contour fillings, markers, scale bar
  • 7.5. Displaying or saving to an image file
  • 7.6. Surface plotting
  • 7.7. Interactive plots
    • 7.7.1. 3D Plots of statistical maps or atlases on the cortical surface
      • 7.7.1.1. view_img_on_surf: Surface plot using a 3D statistical map
      • 7.7.1.2. view_surf: Surface plot using a surface map and a cortical mesh
      • 7.7.1.3. plot_surf_stat_map: Surface plot using a surface map and a cortical mesh
    • 7.7.2. 3D Plots of connectomes
    • 7.7.3. 3D Plots of markers
    • 7.7.4. Interactive visualization of statistical map slices
• 8. Analyzing fMRI using GLMs
  • 8.1. An introduction to GLMs in fMRI statistical analysis
    • 8.1.1. A primer on BOLD-fMRI data analysis
      • 8.1.1.1. What is fMRI ?
      • 8.1.1.2. fMRI data modelling
      • 8.1.1.3. fMRI statistical analysis
      • 8.1.1.4. Multiple Comparisons
  • 8.2. First level models
    • 8.2.1. HRF models
    • 8.2.2. Design matrix: event-based and time series-based
      • 8.2.2.1. Event-based
      • 8.2.2.2. Time series-based
    • 8.2.3. Fitting a first level model
      • 8.2.3.1. Computing contrasts
    • 8.2.4. Extracting predicted time series and residuals
    • 8.2.5. Surface-based analysis
  • 8.3. Second level models
    • 8.3.1. Fitting a second level model
    • 8.3.2. Thresholding statistical maps
    • 8.3.3. Multiple comparisons correction
    • 8.3.4. Voxel based morphometry
• 9. Manipulation brain volumes with nilearn
  • 9.1. Input and output: neuroimaging data representation
    • 9.1.1. Inputing data: file names or image objects
      • 9.1.1.1. File names and objects, 3D and 4D images
      • 9.1.1.2. File name matching: “globbing” and user path expansion
    • 9.1.2. Fetching open datasets from Internet
    • 9.1.3. Understanding neuroimaging data
      • 9.1.3.1. Nifti and Analyze data
      • 9.1.3.2. Niimg-like objects
      • 9.1.3.3. Text files: phenotype or behavior
  • 9.2. Manipulating images: resampling, smoothing, masking, ROIs…
    • 9.2.1. Functions for data preparation and image transformation
    • 9.2.2. Resampling images
      • 9.2.2.1. Resampling one image to match another one
      • 9.2.2.2. Resampling to a specific target affine, shape, or resolution
    • 9.2.3. Accessing individual volumes in 4D images
    • 9.2.4. Computing and applying spatial masks
      • 9.2.4.1. Extracting a brain mask
      • 9.2.4.2. Masking data: from 4D Nifti images to 2D data arrays
    • 9.2.5. Image operations: creating a ROI mask manually
  • 9.3. From neuroimaging volumes to data matrices: the masker objects
    • 9.3.1. The concept of “masker” objects
    • 9.3.2. NiftiMasker: applying a mask to load time-series
      • 9.3.2.1. Custom data loading: loading only the first 100 time points
      • 9.3.2.2. Controlling how the mask is computed from the data
        • 9.3.2.2.1. Visualizing the computed mask
        • 9.3.2.2.2. Different masking strategies
        • 9.3.2.2.3. Extra mask parameters: opening, cutoff…
      • 9.3.2.3. Common data preparation steps: smoothing, filtering, resampling
        • 9.3.2.3.1. Smoothing
        • 9.3.2.3.2. Temporal Filtering and confound removal
        • 9.3.2.3.3. Resampling: resizing and changing resolutions of images
      • 9.3.2.4. Inverse transform: unmasking data
    • 9.3.3. Extraction of signals from regions: NiftiLabelsMasker, NiftiMapsMasker
      • 9.3.3.1. Regions definition
      • 9.3.3.2. NiftiLabelsMasker Usage
      • 9.3.3.3. NiftiMapsMasker Usage
    • 9.3.4. Extraction of signals from regions for multiple subjects: MultiNiftiMasker, MultiNiftiLabelsMasker, MultiNiftiMapsMasker
      • 9.3.4.1. MultiNiftiMasker Usage
      • 9.3.4.2. MultiNiftiLabelsMasker Usage
      • 9.3.4.3. MultiNiftiMapsMasker Usage
    • 9.3.5. Extraction of signals from seeds: NiftiSpheresMasker
• 10. Advanced usage: manual pipelines and scaling up
  • 10.1. Building your own neuroimaging machine-learning pipeline
    • 10.1.1. Data loading and preprocessing
      • 10.1.1.1. Downloading the data
      • 10.1.1.2. Loading non image data: experiment description
      • 10.1.1.3. Masking the data: from 4D image to 2D array
        • 10.1.1.3.1. Applying a mask
        • 10.1.1.3.2. Automatically computing a mask
    • 10.1.2. Applying a scikit-learn machine learning method
    • 10.1.3. Unmasking (inverse_transform)
    • 10.1.4. Visualizing results
    • 10.1.5. Going further
  • 10.2. Downloading statistical maps from the Neurovault repository
    • 10.2.1. Specific images or collections
    • 10.2.2. Selection filters
    • 10.2.3. Output
    • 10.2.4. Neurosynth annotations
    • 10.2.5. Examples using Neurovault
    • 10.2.6. References