Plot Nutmeg style volumetric source estimates using nilearn. Parameters ---------- stc : VectorSourceEstimate The vector source estimate to plot. src : instance of SourceSpaces | instance of SourceMorph The source space. Can also be a SourceMorph to morph the STC to
(
stc,
src,
subject=None,
subjects_dir=None,
mode="stat_map",
bg_img="T1.mgz",
colorbar=True,
colormap="auto",
clim="auto",
transparent=None,
show=True,
initial_time=None,
initial_pos=None,
verbose=None,
)
| 2974 | |
| 2975 | @verbose |
| 2976 | def plot_volume_source_estimates( |
| 2977 | stc, |
| 2978 | src, |
| 2979 | subject=None, |
| 2980 | subjects_dir=None, |
| 2981 | mode="stat_map", |
| 2982 | bg_img="T1.mgz", |
| 2983 | colorbar=True, |
| 2984 | colormap="auto", |
| 2985 | clim="auto", |
| 2986 | transparent=None, |
| 2987 | show=True, |
| 2988 | initial_time=None, |
| 2989 | initial_pos=None, |
| 2990 | verbose=None, |
| 2991 | ): |
| 2992 | """Plot Nutmeg style volumetric source estimates using nilearn. |
| 2993 | |
| 2994 | Parameters |
| 2995 | ---------- |
| 2996 | stc : VectorSourceEstimate |
| 2997 | The vector source estimate to plot. |
| 2998 | src : instance of SourceSpaces | instance of SourceMorph |
| 2999 | The source space. Can also be a SourceMorph to morph the STC to |
| 3000 | a new subject (see Examples). |
| 3001 | |
| 3002 | .. versionchanged:: 0.18 |
| 3003 | Support for :class:`~nibabel.spatialimages.SpatialImage`. |
| 3004 | %(subject_none)s |
| 3005 | If ``None``, ``stc.subject`` will be used. |
| 3006 | %(subjects_dir)s |
| 3007 | mode : ``'stat_map'`` | ``'glass_brain'`` |
| 3008 | The plotting mode to use. For ``'glass_brain'``, activation absolute values are |
| 3009 | displayed after being transformed to a standard MNI brain. |
| 3010 | bg_img : instance of SpatialImage | str |
| 3011 | The background image used in the nilearn plotting function. |
| 3012 | Can also be a string to use the ``bg_img`` file in the subject's |
| 3013 | MRI directory (default is ``'T1.mgz'``). |
| 3014 | Not used in "glass brain" plotting. |
| 3015 | colorbar : bool |
| 3016 | If True, display a colorbar on the right of the plots. |
| 3017 | %(colormap)s |
| 3018 | %(clim)s |
| 3019 | %(transparent)s |
| 3020 | show : bool |
| 3021 | Show figures if True. Defaults to True. |
| 3022 | initial_time : float | None |
| 3023 | The initial time to plot. Can be None (default) to use the time point |
| 3024 | with the maximal absolute value activation across all voxels |
| 3025 | or the ``initial_pos`` voxel (if ``initial_pos is None`` or not, |
| 3026 | respectively). |
| 3027 | |
| 3028 | .. versionadded:: 0.19 |
| 3029 | initial_pos : ndarray, shape (3,) | None |
| 3030 | The initial position to use (in m). Can be None (default) to use the |
| 3031 | voxel with the maximum absolute value activation across all time points |
| 3032 | or at ``initial_time`` (if ``initial_time is None`` or not, |
| 3033 | respectively). |