hippomaps.plotting.surfplot_canonical_foldunfold

hippomaps.plotting.surfplot_canonical_foldunfold(cdata, hemis=['L', 'R'], labels=['hipp', 'dentate'], unfoldAPrescale=False, den='0p5mm', tighten_cwindow=False, resourcesdir='/home/docs/checkouts/readthedocs.org/user_builds/hippomaps/checkouts/latest/hippomaps/resources', size=[350, 300], **qwargs)

Plots canonical folded and unfolded surfaces for hippocampus and dentate gyrus. :param cdata: Array with the shape Vx2xF, where V is the number of vertices (including DG unless specified),

2 is the number of hemispheres (unless specified), and F is the number of rows/features.

Parameters:

  • 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’].

  • 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’.

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

  • 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, 300].

  • **qwargs (dict, optional) – Additional keyword arguments for customization. See https://brainspace.readthedocs.io/en/latest/generated/brainspace.plotting.surface_plotting.plot_surf.html#brainspace.plotting.surface_plotting.plot_surf

Returns:

Figure object for the generated surface plot.

Return type:

matplotlib.figure.Figure

Notes

This function is suitable for plotting canonical folded and unfolded surfaces, and it is particularly useful when the data (cdata) isn’t specific to one subject (e.g., maybe it has been averaged across many subjects).