Coverage for nilearn/__init__.py: 75%
8 statements
« prev ^ index » next coverage.py v7.9.1, created at 2025-06-16 12:32 +0200
« prev ^ index » next coverage.py v7.9.1, created at 2025-06-16 12:32 +0200
1"""
2Machine Learning module for NeuroImaging in python.
3---------------------------------------------------
5Documentation is available in the docstrings and online at
6https://nilearn.github.io.
8Contents
9--------
11Nilearn aims at simplifying the use of the scikit-learn package
12in the context of neuroimaging.
13It provides specific input/output functions, algorithms and
14visualization tools.
16Submodules
17---------
19connectome --- Set of tools for computing functional
20 connectivity matrices
21 and for sparse multi-subjects learning
22 of Gaussian graphical models
23datasets --- Utilities to download NeuroImaging datasets
24decoding --- Decoding tools and algorithms
25decomposition --- Includes a subject level variant of the ICA
26 algorithm called Canonical ICA
27glm --- Analyzing fMRI data using GLMs
28image --- Set of functions defining mathematical operations
29 working on Niimg-like objects
30interfaces --- Includes tools to preprocess neuro-imaging data
31 from various common interfaces like fMRIPrep.
32maskers --- Includes scikit-learn transformers.
33masking --- Utilities to compute and operate on brain masks
34mass_univariate --- Defines a Massively Univariate Linear Model
35 estimated with OLS and permutation test
36plotting --- Plotting code for nilearn
37regions --- Set of functions for extracting region-defined
38 signals, clustering methods,
39 connected regions extraction
40reporting --- Implements functions useful
41 to report analysis results
42signal --- Set of preprocessing functions for time series
43surface --- Functions and classes to work with surfaces
44"""
46try:
47 from ._version import __version__
48except ImportError:
49 __version__ = "0+unknown"
52# Boolean controlling the default globbing technique when using check_niimg
53# and the os.path.expanduser usage in CacheMixin.
54# Default value it True, set it to False to completely deactivate this
55# behavior.
56EXPAND_PATH_WILDCARDS = True
58DEFAULT_DIVERGING_CMAP = "RdBu_r"
59DEFAULT_SEQUENTIAL_CMAP = "inferno"
61# list all submodules available in nilearn and version
62__all__ = [
63 "__version__",
64 "connectome",
65 "datasets",
66 "decoding",
67 "decomposition",
68 "glm",
69 "image",
70 "interfaces",
71 "maskers",
72 "masking",
73 "mass_univariate",
74 "plotting",
75 "regions",
76 "reporting",
77 "signal",
78 "surface",
79]