Skip to main content

For generating surrogate brain maps with spatial autocorrelation using geometric eigenmodes.

Project description


Latest PyPI version Zenodo DOI deploy-docs status

The eigenstrapping toolbox is designed to help researchers generate statistically-rigorous models for null hypothesis testing between brain maps using non-local spectral shape descriptors - or geometric eigenmodes. Documentation can be found here.

Features

  • A growing library of eigenmodes of standard surfaces and surface densities (fsaverage, fsLR)

  • Cortical and subcortical null models for assessing statistical correspondence between brain maps

  • Generation of geometric eigenmodes on user-derived surfaces

Installation Guide

Eigenstrapping is available in Python 3.7+. MATLAB version coming soon!

Dependencies

To install eigenstrapping, the following Python packages are required:

nibabel and nilearn are required for surfaces and volumes. matplotlib is only required for fitting plots in fit.py and some of the surface plotting functions. Future improvements will reduce the number of dependencies needed.

Additional dependencies

Installation

eigenstrapping can be installed using pip:

pip install eigenstrapping

Alternatively, you can install the package from the Github repository:

git clone https://github.com/SNG-newy/eigenstrapping.git
cd eigenstrapping
python setup.py install

Citing

When using eigenstrapping, please cite the following manuscript:

  • null

And please also cite the papers for the method that we use to calculate eigenmodes on the surface:

License information

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License cc-by-nc-sa. The full license can be found in the LICENSE file in the eigenstrapping distribution.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

eigenstrapping-0.0.1.10.tar.gz (97.8 kB view hashes)

Uploaded Source

Built Distribution

eigenstrapping-0.0.1.10-py3-none-any.whl (89.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page