Skip to content

Commit

Permalink
Dev docs nilearn/nilearn@c10b1a5 : [MAINT] Make sure only changed exa…
Browse files Browse the repository at this point in the history
…mples are rebuilt on PR (#4780)
  • Loading branch information
actions-user committed Nov 22, 2024
1 parent 9aa89d8 commit edc596e
Show file tree
Hide file tree
Showing 717 changed files with 4,209 additions and 4,455 deletions.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified dev/_downloads/2ce0f24d145edf0cb7091fe8dae3bd07/plot_carpet.zip
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
# brain.
#
# Practically, this means that the main difference between the two is the basic
# unit that holds the data. For volumetric images, that basic unit is a voxel,
# unit that holds the data.
# For volumetric images, that basic unit is a voxel,
# while for surface images it is a :term:`vertex`.
#
# The goal of this tutorial is to show you how to work with surface images in
Expand All @@ -44,7 +45,8 @@
# representation.
#
# For brain surfaces we typically have two meshes: one for the left hemisphere
# and one for the right hemisphere. Nilearn represents this as a
# and one for the right hemisphere.
# Nilearn represents this as a
# :class:`~nilearn.surface.PolyMesh` object with two ``parts``:
# ``left`` and ``right``.
#
Expand Down Expand Up @@ -97,7 +99,8 @@
# ----
#
# The data is the information stored at each :term:`vertex` of the
# :term:`mesh`. This can be anything from the thickness of the cortex to the
# :term:`mesh`.
# This can be anything from the thickness of the cortex to the
# activation level at that :term:`vertex`.
#
# For this example, let's create some random data for the vertices of the
Expand All @@ -123,7 +126,8 @@
# --------------------------
#
# The surface image can be plotted using the different functions from the
# :mod:`nilearn.plotting` module. Here we will show how to use the
# :mod:`nilearn.plotting` module.
# Here we will show how to use the
# :func:`~nilearn.plotting.view_surf` function:
from nilearn import plotting

Expand Down Expand Up @@ -163,7 +167,8 @@

# %%
# You will see that this creates four files in total -- two for the
# :term:`mesh` and two for the data. The files ending with ``_hemi-L.gii``
# :term:`mesh` and two for the data.
# The files ending with ``_hemi-L.gii``
# correspond to the left part and those ending with ``_hemi-R.gii`` correspond
# to the right part.

Expand Down Expand Up @@ -202,7 +207,8 @@
# ---------------
#
# Most things that can be done with volumetric images can also be done with
# surface images. See following examples for more details:
# surface images.
# See following examples for more details:
#
# * For plotting statistical maps on the surface, see
# :ref:`sphx_glr_auto_examples_01_plotting_plot_surf_stat_map.py`
Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified dev/_downloads/44cb3a7d606fae23fb2b04d989cc6947/plot_hrf.zip
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified dev/_downloads/4f6c009516d6956f180d8a05a141b383/plot_oasis.zip
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified dev/_downloads/a61865436a8c739855dd39d7e9ff3f6e/plot_overlay.zip
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified dev/_downloads/ec9ec7cc0c1ea84207d4b1895aa51c35/plot_atlas.zip
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## What is a surface image?\n\nWithin the context of neuroimaging, a surface image is an alternative way of\nrepresenting MRI data as opposed to a volumetric image.\n\nWhile volumetric images are 3D grids of voxels, surface images consist of\npoints (vertices) in 3D space connected to represent the surface of the\nbrain.\n\nPractically, this means that the main difference between the two is the basic\nunit that holds the data. For volumetric images, that basic unit is a voxel,\nwhile for surface images it is a :term:`vertex`.\n\nThe goal of this tutorial is to show you how to work with surface images in\nNilearn. For more existential questions like why surface images are useful,\nhow they are created etc., [Andy Jahn's blog](https://andysbrainbook.readthedocs.io/en/latest/FreeSurfer/FreeSurfer_Introduction.html)\nis a good starting point.\n\nSurface images have two main components:\n 1. The :term:`mesh`, which is the geometry of the surface.\n 2. The data, which is the information stored at each vertex of the mesh.\n\n"
"## What is a surface image?\n\nWithin the context of neuroimaging, a surface image is an alternative way of\nrepresenting MRI data as opposed to a volumetric image.\n\nWhile volumetric images are 3D grids of voxels, surface images consist of\npoints (vertices) in 3D space connected to represent the surface of the\nbrain.\n\nPractically, this means that the main difference between the two is the basic\nunit that holds the data.\nFor volumetric images, that basic unit is a voxel,\nwhile for surface images it is a :term:`vertex`.\n\nThe goal of this tutorial is to show you how to work with surface images in\nNilearn. For more existential questions like why surface images are useful,\nhow they are created etc., [Andy Jahn's blog](https://andysbrainbook.readthedocs.io/en/latest/FreeSurfer/FreeSurfer_Introduction.html)\nis a good starting point.\n\nSurface images have two main components:\n 1. The :term:`mesh`, which is the geometry of the surface.\n 2. The data, which is the information stored at each vertex of the mesh.\n\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Mesh\n\nA :term:`mesh` can be defined by two arrays:\n 1. The coordinates of the vertices.\n 2. Which vertices need to be connected to form :term:`faces`.\n\n<div class=\"alert alert-info\"><h4>Note</h4><p>This representation of a mesh is known as [Face-Vertex](https://en.wikipedia.org/wiki/Polygon_mesh#Face-vertex_meshes)\n representation.</p></div>\n\nFor brain surfaces we typically have two meshes: one for the left hemisphere\nand one for the right hemisphere. Nilearn represents this as a\n:class:`~nilearn.surface.PolyMesh` object with two ``parts``:\n``left`` and ``right``.\n\nSo you can define your own :term:`mesh`, say, for the left part a tetrahedron\nand for the right part a pyramid, using numpy arrays and create a\n:class:`~nilearn.surface.PolyMesh` object as follows:\n\n"
"## Mesh\n\nA :term:`mesh` can be defined by two arrays:\n 1. The coordinates of the vertices.\n 2. Which vertices need to be connected to form :term:`faces`.\n\n<div class=\"alert alert-info\"><h4>Note</h4><p>This representation of a mesh is known as [Face-Vertex](https://en.wikipedia.org/wiki/Polygon_mesh#Face-vertex_meshes)\n representation.</p></div>\n\nFor brain surfaces we typically have two meshes: one for the left hemisphere\nand one for the right hemisphere.\nNilearn represents this as a\n:class:`~nilearn.surface.PolyMesh` object with two ``parts``:\n``left`` and ``right``.\n\nSo you can define your own :term:`mesh`, say, for the left part a tetrahedron\nand for the right part a pyramid, using numpy arrays and create a\n:class:`~nilearn.surface.PolyMesh` object as follows:\n\n"
]
},
{
Expand All @@ -36,7 +36,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## Data\n\nThe data is the information stored at each :term:`vertex` of the\n:term:`mesh`. This can be anything from the thickness of the cortex to the\nactivation level at that :term:`vertex`.\n\nFor this example, let's create some random data for the vertices of the\n:term:`mesh`:\n\n"
"## Data\n\nThe data is the information stored at each :term:`vertex` of the\n:term:`mesh`.\nThis can be anything from the thickness of the cortex to the\nactivation level at that :term:`vertex`.\n\nFor this example, let's create some random data for the vertices of the\n:term:`mesh`:\n\n"
]
},
{
Expand Down Expand Up @@ -72,7 +72,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## Plotting the surface image\n\nThe surface image can be plotted using the different functions from the\n:mod:`nilearn.plotting` module. Here we will show how to use the\n:func:`~nilearn.plotting.view_surf` function:\n\n"
"## Plotting the surface image\n\nThe surface image can be plotted using the different functions from the\n:mod:`nilearn.plotting` module.\nHere we will show how to use the\n:func:`~nilearn.plotting.view_surf` function:\n\n"
]
},
{
Expand Down Expand Up @@ -151,7 +151,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"You will see that this creates four files in total -- two for the\n:term:`mesh` and two for the data. The files ending with ``_hemi-L.gii``\ncorrespond to the left part and those ending with ``_hemi-R.gii`` correspond\nto the right part.\n\n"
"You will see that this creates four files in total -- two for the\n:term:`mesh` and two for the data.\nThe files ending with ``_hemi-L.gii``\ncorrespond to the left part and those ending with ``_hemi-R.gii`` correspond\nto the right part.\n\n"
]
},
{
Expand Down Expand Up @@ -194,7 +194,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"And that's it! Now you know how to create, plot, save and load surface images\nwith Nilearn.\n\n## Further reading\n\nMost things that can be done with volumetric images can also be done with\nsurface images. See following examples for more details:\n\n* For plotting statistical maps on the surface, see\n `sphx_glr_auto_examples_01_plotting_plot_surf_stat_map.py`\n\n* For performing GLM analysis on surface data organized in BIDS\n format, see\n `sphx_glr_auto_examples_07_advanced_plot_surface_bids_analysis.py`\n\n* For performing first-level GLM analysis on surface data, see [this \\\n example](../04_glm_first_level/plot_localizer_surface_analysis.html).\n\n"
"And that's it! Now you know how to create, plot, save and load surface images\nwith Nilearn.\n\n## Further reading\n\nMost things that can be done with volumetric images can also be done with\nsurface images.\nSee following examples for more details:\n\n* For plotting statistical maps on the surface, see\n `sphx_glr_auto_examples_01_plotting_plot_surf_stat_map.py`\n\n* For performing GLM analysis on surface data organized in BIDS\n format, see\n `sphx_glr_auto_examples_07_advanced_plot_surface_bids_analysis.py`\n\n* For performing first-level GLM analysis on surface data, see [this \\\n example](../04_glm_first_level/plot_localizer_surface_analysis.html).\n\n"
]
}
],
Expand Down
Binary file not shown.
Binary file not shown.
Binary file modified dev/_images/sphx_glr_plot_advanced_decoding_scikit_001.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/sphx_glr_plot_advanced_decoding_scikit_thumb.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/sphx_glr_plot_first_level_details_024.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/sphx_glr_plot_haxby_anova_svm_001.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/sphx_glr_plot_haxby_anova_svm_thumb.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/sphx_glr_plot_haxby_different_estimators_001.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/sphx_glr_plot_haxby_different_estimators_002.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/sphx_glr_plot_haxby_different_estimators_005.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/sphx_glr_plot_haxby_different_estimators_thumb.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/sphx_glr_plot_haxby_grid_search_001.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/sphx_glr_plot_haxby_grid_search_thumb.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/sphx_glr_plot_haxby_mass_univariate_002.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/sphx_glr_plot_haxby_searchlight_001.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/sphx_glr_plot_haxby_searchlight_thumb.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/sphx_glr_plot_oasis_vbm_004.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/sphx_glr_plot_second_level_association_test_003.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/sphx_glr_plot_second_level_one_sample_test_003.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/sphx_glr_plot_simulated_data_002.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/sphx_glr_plot_simulated_data_003.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/sphx_glr_plot_simulated_data_006.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/sphx_glr_plot_surface_image_and_maskers_004.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ statistical map:
.. code-block:: none
<nilearn.plotting.displays._slicers.OrthoSlicer object at 0x7ff4c77fc940>
<nilearn.plotting.displays._slicers.OrthoSlicer object at 0x7f2ab2e03fd0>
Expand Down Expand Up @@ -156,7 +156,7 @@ Visualizing works better with a threshold
.. code-block:: none
<nilearn.plotting.displays._slicers.OrthoSlicer object at 0x7ff4df9d9160>
<nilearn.plotting.displays._slicers.OrthoSlicer object at 0x7f2acafd2880>
Expand Down Expand Up @@ -186,7 +186,6 @@ correspondence between rest and task
[get_dataset_dir] Dataset created in /home/runner/nilearn_data/smith_2009
[fetch_single_file] Downloading data from
https://www.fmrib.ox.ac.uk/datasets/brainmap+rsns/PNAS_Smith09_rsn10.nii.gz ...
[_chunk_report_] Downloaded 1753088 of 7565016 bytes (23.2%%, 3.5s remaining)
[fetch_single_file] ...done. (2 seconds, 0 min)
Expand Down Expand Up @@ -271,7 +270,7 @@ We can then plot it
.. code-block:: none
<nilearn.plotting.displays._slicers.OrthoSlicer object at 0x7ff4d5c1f040>
<nilearn.plotting.displays._slicers.OrthoSlicer object at 0x7f2acafab160>
Expand Down Expand Up @@ -489,7 +488,7 @@ image.

.. rst-class:: sphx-glr-timing

**Total running time of the script:** (0 minutes 21.791 seconds)
**Total running time of the script:** (0 minutes 22.810 seconds)

**Estimated memory usage:** 352 MB

Expand Down
Loading

0 comments on commit edc596e

Please sign in to comment.