hippomaps.plotting.surfplot_sub_foldunfold

hippomaps.plotting.surfplot_sub_foldunfold(hippunfold_dir, sub, ses, features, hemis=['L', 'R'], labels=['hipp', 'dentate'], flipRcurv=True, unfoldAPrescale=False, den='0p5mm', modality='T1w', tighten_cwindow=True, rotate=20, resourcesdir='/home/docs/checkouts/readthedocs.org/user_builds/hippomaps/checkouts/latest/hippomaps/resources', size=[350, 230], cmap='viridis', **qwargs)

Plots subject-specific folded and unfolded surfaces (hipp/dentate; folded/unfolded).

Parameters:

  • hippunfold_dir (str) – Directory path containing unfolded hippocampus data.

  • sub (str) – Subject ID. Inputs are path/filenames

  • ses (str) – Session ID. Inputs are path/filenames

  • features (str) – Feature or measurement to visualize on the surface plot. Can include thickness, curvature, gyrification, subfields, or other added data that follows the same naming convention.

  • hemis (list of str, optional) – List of hemispheres to visualize. Default is [β€˜L’, β€˜R’].

  • labels (list of str, optional) – List of labels for different structures. Default is [β€˜hipp’, β€˜dentate’].

  • flipRcurv (bool, optional) – Whether to flip the curvature map for the right hemisphere. Default is True.

  • unfoldAPrescale (bool, optional) – Whether to pre-scale the anterior-posterior axis during unfolding. Default is False.

  • den (str, optional) – Density parameter for surface plot. Default is β€˜0p5mm’.

  • modality (str, optional) – Imaging modality (e.g., β€˜T1w’). Default is β€˜T1w’.

  • tighten_cwindow (bool, optional) – Whether to tighten the color window for the surface plot. Default is True.

  • rotate (bool, optional) – Whether to rotate the surface plot. Default is True.

  • resourcesdir (str, optional) – Directory path containing additional resources. Default is the value of resourcesdir.

  • size (list of int, optional) – Size of the surface plot. Default is [350, 230].

  • cmap (str, optional) – Colormap for the surface plot. Default is β€˜viridis’.

  • **qwargs (dict, optional) – Additional keyword arguments for customization.

Returns:

The function generates a surface plot for the specified subject’s folded and unfolded hippocampus.

Return type:

matplotlib.figure.Figure