gastropy.plot_coupling_map

gastropy.plot_coupling_map#

gastropy.plot_coupling_map(data, affine=None, threshold=None, title='Gastric-Brain Coupling (PLV)', cmap='YlOrRd', vmax=None, ax=None, **kwargs)[source]#

Plot a volumetric coupling map as an anatomical overlay.

Wrapper around nilearn.plotting.plot_stat_map with defaults appropriate for PLV maps (non-negative, warm colormap).

Parameters:

  • data (np.ndarray or nibabel.Nifti1Image) – 3D coupling volume (e.g., PLV or z-score map). If a numpy array, affine must be provided.

  • affine (np.ndarray, optional) – 4x4 affine matrix. Required if data is a numpy array.

  • threshold (float, optional) – Values below this threshold are not displayed.

  • title (str, optional) – Plot title.

  • cmap (str, optional) – Matplotlib colormap. Default is "YlOrRd" for PLV, use "RdBu_r" for z-score maps.

  • vmax (float, optional) – Maximum value for the colormap.

  • ax (matplotlib.axes.Axes, optional) – Pre-existing axes. If None, a new figure is created.

  • **kwargs – Additional arguments passed to nilearn.plotting.plot_stat_map.

Returns:

display – Nilearn display object for further customization.

Return type:

nilearn.plotting.displays.OrthoSlicer

Contents