brainstat.datasets.base.fetch_gradients

brainstat.datasets.base.fetch_gradients(template='fsaverage5', name='margulies2016', data_dir=None, overwrite=False)[source]

Fetch example gradients.

Parameters

  • template (str, optional) – Name of the template surface. Valid values are “fsaverage5”, “fsaverage”, “fslr32k”, defaults to “fsaverage5”.

  • name (str) – Name of the gradients. Valid values are “margulies2016”, defaults to “margulies2016”.

  • data_dir (str, Path, optional) – Path to the directory to store the gradient data files, by default $HOME_DIR/brainstat_data/gradient_data.

  • overwrite (bool, optional) – If true, overwrites existing files, by default False.

Returns

numpy.ndarray – Vertex-by-gradient matrix.