Skip to content
This repository has been archived by the owner on Feb 13, 2024. It is now read-only.

morteza/nilearn-extra

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Nilearn Extra

Nilearn Extra is a small add-on for Nilearn (Statistics for NeuroImaging in Python). It currently adds some functional connectivity measures to the mix.

The package is a work-in-progress. There are bugs, and example notebooks are missing. If you want to use this package, expect to make changes.

Installation

pip install nilearn-extra

Usage

- from nilearn.connectome import ConnectivityMeasure
+ from nilearn_extra.connectome import ConnectivityMeasure

Extra Connectivity Matrices

Nilearn Extra supports two additional connectivity matrices:

  • Chatterjee XiCorr (kind="chatterjee") is a new correlation coefficient as described in Chatterjee (2019).
  • Transfer Entropy (kind="transfer entropy") between regions X and Y is amount of uncertainty reduced in Y by knowing the past values of X. Transfer entropy is an asymmetric measure, so is the connectivity matrix.

Optional Dependencies

# transfer entropy connectivity requires `pyinform` package.
pip install pyinform

Contributing

We use GitHub to fork and manage pull requests.

Acknowledgements

This project is supported by the Luxembourg National Research Fund (ATTRACT/2016/ID/11242114/DIGILEARN).

License

BSD 3-Clause License. See the LICENSE file.