brainstat.context.resting.gradients_corr

brainstat.context.resting.gradients_corr(data, name='margulies2016', template='fsaverage5', data_dir=None, overwrite=False)[source]

Comptues the correlation of the input data with the Margulies gradients.

Parameters

  • data (ArrayLike) – The data to be compared to the Margulies gradients. Data must be in the shape of vertices-by-features.

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

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

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

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

Returns

np.ndarray – Correlations between the input data and the Margulies gradients.