cortex.database.Database.get_surf

Database.get_surf(subject: str, type: str, hemisphere: Literal['both'] = 'both', *, merge: Literal[True], nudge: bool = False) → tuple[NDArray[floating], NDArray[integer]]

Database.get_surf(subject: str, type: str, hemisphere: Literal['both'] = 'both', merge: Literal[False] = False, nudge: bool = False) → tuple[tuple[NDArray[floating], NDArray[integer]], tuple[NDArray[floating], NDArray[integer]]]

Database.get_surf(subject: str, type: str, hemisphere: Literal['lh', 'rh'], merge: bool = False, nudge: bool = False) → tuple[NDArray[floating], NDArray[integer]]

Database.get_surf(subject: str, type: str, hemisphere: Literal['lh', 'rh', 'both'] = 'both', merge: bool = False, nudge: bool = False) → tuple[tuple[NDArray[floating], NDArray[integer]], tuple[NDArray[floating], NDArray[integer]]] | tuple[NDArray[floating], NDArray[integer]]

Return the surface pair for the given subject, surface type, and hemisphere.

Parameters:

subjectstr

Name of the subject

typestr

Type of surface to return, probably in (fiducial, inflated, veryinflated, hyperinflated, superinflated, flat)

hemisphere“lh”, “rh”

Which hemisphere to return

mergebool

Vstack the hemispheres, if requesting both

nudgebool

Nudge the hemispheres apart from each other, for overlapping surfaces (inflated, etc)

Returns:

left, right

If request is for both hemispheres, otherwise:

pts, polys, norms((p,3) array, (f,3) array, (p,3) array or None)

For single hemisphere