/searchlights

Precomputed searchlights for surface-based analysis.

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

codecov PyPI PyPI - Downloads PyPI - Python Version

searchlights is a Python package that provides precomputed searchlights for surface-based analysis of fMRI data. It only depends on NumPy.

Installation

The package can be installed with pip:

python -m pip install searchlights

Example usage

The surface-based fMRI data we usually use (e.g., Feilong et al., 2018) are in fsaverage space, downsampled to a lower resolution (icoorder5, approximately 3 mm vertex spacing). The surface has 9372 vertices for the left hemisphere, and 9370 vertices for the right hemisphere. The code below shows how to get the searchlights for the left hemisphere with a 20 mm radius.

import numpy as np
from searchlights import get_searchlights
sls = get_searchlights('l', 20, 'fsaverage')

See the documentation for more examples and details.