hippomaps.stats.eigenstrapping

hippomaps.stats.eigenstrapping(imgfix, imgperm, nperm=10000, metric='pearsonr', label='hipp', den='0p5mm', num_modes=200, permute=False, resample=False, **qwargs)

Awesome new tool at https://www.biorxiv.org/content/10.1101/2024.02.07.579070v1.abstract Generates null models of spatial maps by rotating geometric eigenmodes. Koussis, N. C., Pang, J. C., Jeganathan, J., Paton, B., Fornito, A., Robinson, P. A., … & Breakspear, M. (2024). Generation of surrogate brain maps preserving spatial autocorrelation through random rotation of geometric eigenmodes. bioRxiv, 2024-02.

Parameters:

  • imgfix (str or array) – Path to the fixed map, or fixed array map.

  • imgperm (str or array) – Path to the fixed map to be permuted, or array map to be permuted.

  • nperm (int) – Number of permutations to perform.

  • metric (str, optional) – Metric for comparing maps (one of pearsonr, spearmanr). Default is β€˜pearsonr’.

  • label (str, optional) – Label for the hippocampus (β€˜hipp’ or β€˜dentate’). Default is β€˜hipp’.

  • den (str, optional) – Density of the surface data. Default β€˜0p5mm’.

  • num_modes (int, optional) – Number of eigenmodes to use. Default is 200.

  • permute (bool, optional) – Set whether to permute surrogate map from original map to preserve values. Default is False.

  • resample (bool, optional) – Set whether to resample surrogate map from original map to preserve values. Default is False.

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

Returns:

  • metricnull (Null distribution of the specified metric)

  • permutedimg (All permuted spatial maps at β€˜unfoldiso’ density.)

  • r_obs (The observed association between the two aligned maps.)

  • pval (p-value based on metricnull r_obs.)