plot_subj

plot_subj(inst: ~mne.io.base.BaseRaw | ~mne.epochs.BaseEpochs | ~mne.evoked.Evoked | ~mne._fiff.meas_info.Info | str, subj_dir: str | ~os.PathLike = None, picks: list[str | int] = None, no_wm: bool = False, labels_every: int | None = 8, surface: str = 'pial', hemi: str = 'both', fig: ~mne.viz._brain._brain.Brain = None, trans=None, color: <module 'matplotlib.colors' from '/home/docs/checkouts/readthedocs.org/user_builds/ieeg-pipelines/conda/latest/lib/python3.12/site-packages/matplotlib/colors.py'> = None, size: float = 0.35, show: bool = True, background: str = 'white', title: str = None, units: str = 'm', transparency: float = 0.5, cortex: str = 'low_contrast') → Brain[source][source]

Plots the electrodes on the subject’s brain

Parameters:

  • inst (Signal | mne.Info | str) – The subject to plot

  • subj_dir (PathLike, optional) – The subjects directory, by default HOME / ‘Box’ / ‘ECoG_Recon’

  • picks (list[str | int], optional) – The channels to plot, by default all

  • no_wm (bool, optional) – Whether to remove the white matter channels, by default False

  • labels_every (int, optional) – How often to label the channels, by default 8

  • fig (Brain, optional) – The figure to plot on, by default None

  • surface (str, optional) – The surface to plot, by default ‘pial’

  • hemi (str, optional) – The hemisphere to plot, by default ‘split’

  • trans (mne.transforms.Transform, optional) – The transformation to apply, by default None

  • color (matplotlib.colors, optional) – The color of the electrodes, by default (1,1,1)

  • size (float, optional) – The size of the electrodes, by default 0.35

  • show (bool, optional) – Whether to show the figure, by default True

  • background (str, optional) – Background color

  • title (string, optional) – Title the plot

  • units (str, optional) – Units of the electrodes

  • transparency (float, optional) – Transparency of the brain

  • cortex (str, optional) – The cortex to plot

Returns:

The brain plot

Return type:

Brain

Examples using ieeg.viz.mri.plot_subj

Subject Brain Plotting Example

Subject Brain Plotting Example