Skip to main content

A Python package for functional ROI analyses of fMRI data

Project description

Documentation Status

The funROI (FUNctional Region Of Interest) toolbox is designed to provide robust analytic methods for fMRI data analyses that accommodate inter-subject variability in the precise locations of functional activations.

https://github.com/GT-LIT-Lab/funROI/raw/main/doc/source/funROI-collage.png

Features

  • Parcel generation: generates parcels (brain masks) based on individual activation maps, which can serve as a spatial constraint for subsequent subject-level analyses. (This step can be skipped if you already have parcels of interest).

  • fROI definition: defines functional regions of interest (fROIs) by selecting a subset of functionally responsive voxels within predefined parcels.

  • Effect estimation: extracts average effect sizes for each subject-specific fROI.

  • Spatial correlation estimation: quantifies the similarity of within-subject activation patterns across conditions (within either a parcel or an fROI).

  • Spatial overlap estimation: calculates the overlap between parcels and/or fROIs from different subjects or definitions.

Installation

Install funROI via pip:

pip install funROI

Usage

For more details and examples, please refer to the full documentation at: https://funroi.readthedocs.io/en/latest/

Citation

If you use funROI in your work, please cite it as follows:

Gao, R., & Ivanova, A. A. (2025). funROI: A Python package for functional ROI analyses of fMRI data (Version 1). Figshare. https://doi.org/10.6084/m9.figshare.28120967.v1

Acknowledgements

This toolbox implements the parcel definition, fROI definition, and fROI effect size estimation methods described in Fedorenko et al. (2010). It builds heavily on the spm_ss toolbox, which provides a Matlab-based implementation for fROI analyses. We thank Alfonso Nieto-Castañon and Ev Fedorenko for developing these methods.

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

funroi-1.0.0.post1.tar.gz (31.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

funroi-1.0.0.post1-py2.py3-none-any.whl (38.2 kB view details)

Uploaded Python 2Python 3

File details

Details for the file funroi-1.0.0.post1.tar.gz.

File metadata

  • Download URL: funroi-1.0.0.post1.tar.gz
  • Upload date:
  • Size: 31.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for funroi-1.0.0.post1.tar.gz
Algorithm Hash digest
SHA256 68e0677246399daede470853dc87ccccb080eb8c54a5334b95de72c10c02046b
MD5 c91ebe817d14117459025177a0fde596
BLAKE2b-256 a259cf473ec50737a03aafef21f0be3a41cd59adf0fe3741467c3a5e0de248d1

See more details on using hashes here.

File details

Details for the file funroi-1.0.0.post1-py2.py3-none-any.whl.

File metadata

  • Download URL: funroi-1.0.0.post1-py2.py3-none-any.whl
  • Upload date:
  • Size: 38.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for funroi-1.0.0.post1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a2663c182b178c76f0c368b2c91633ebc38706dfff0fc5c658c0d6aa45a43ce4
MD5 05c689b522bb95809d759f8e7ad1a18b
BLAKE2b-256 5860d974868a48dc010a99845e054ed10793f845ba04127cbf71c9735a5d2139

See more details on using hashes here.

Supported by

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