brainstat.datasets.base.fetch_template_surface

brainstat.datasets.base.fetch_template_surface(template, join=True, layer=None, data_dir=None)[source]

Loads surface templates.

Parameters

  • template (str) – Name of the surface template. Valid values are “fslr32k”, “fsaverage”, “fsaverage3”, “fsaverage4”, “fsaverage5”, “fsaverage6”, “civet41k”, “civet164k”.

  • join (bool, optional) – If true, returns surfaces as a single object, if false, returns an object per hemisphere, by default True.

  • layer (str, optional) – Name of the cortical surface of interest. Valid values are “white”, “smoothwm”, “pial”, “inflated”, “sphere” for fsaverage surfaces; “midthickness”, “inflated”, “vinflated” for “fslr32k”; “mid”, “white” for CIVET surfaces; and “sphere” for “civet41k”. If None, defaults to “pial” or “midthickness”, by default None.

  • data_dir (str, Path, optional) – Directory to save the data, by default $HOME_DIR/brainstat_data/surface_data.

Returns

BSPolyData or tuple of BSPolyData – Output surface(s). If a tuple, then the first element is the left hemisphere.