Skip to main content

A package for computing reliability of MRI/fMRI images

Project description

PyReliMRI: Python-based Reliability in MRI

Python package Documentation Status PyPI Funded By DOI

Pyrelimri Logo

Introduction

PyReliMRI provides multiple reliability metrics for task fMRI and resting state fMRI data, essential
for assessing the consistency and reproducibility of MRI-based research. The package is described and used in the Preprint Pyrelimri Features

Authors

Citation

If you use PyReliMRI in your research, please cite it using the following DOI:

Demidenko, M., Mumford, J., & Poldrack, R. (2024). PyReliMRI: An Open-source Python tool for Estimates of Reliability
in MRI Data (2.1.0) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.12522260

Purpose

Reliability questions for task fMRI and resting state fMRI are increasing. As described in 2010, there are various ways that researchers calculate reliability. Few open-source packages exist to calculate multiple individual and group reliability metrics using one tool. PyReliMRI offers comprehensive tools for calculating reliability metrics in MRI data at both individual and group levels. It supports various MRI analysis scenarios including multi-run and multi-session studies.

Features

  • Group Level:

    • similarity.py: Calculates similarity coefficients between fMRI images.
    • icc.py: Computes Intraclass Correlation Coefficients (ICC) across subjects.
  • Individual Level:

    • brain_icc.py: Computes voxel-wise (can parallelize w/ n_jobs) and atlas-based ICC.
    • conn_icc.py: Estimates ICC for precomputed correlation matrices.
  • Utility:

    • masked_timeseries.py: Extracts and processes timeseries data from ROI masks or coordinates.

Scripts Overview

Script Name Functions Inputs Purpose
brain_icc.py voxelwise_icc, roi_icc See detailed descriptions for required and optional inputs. Calculates intraclass correlation (ICC) metrics for voxel-wise and ROI-based data, supporting various ICC types and outputs.
icc.py sumsq_total, sumsq, sumsq_btwn, icc_confint, sumsq_icc Panda long dataframe with subject, session, scores, and ICC type inputs required. Computes sum of squares and ICC estimates with confidence intervals, useful for assessing reliability across measurements.
similarity.py image_similarity, pairwise_similarity Input paths for Nifti images and optional parameters for image similarity calculations. Computes similarity coefficients between fMRI images, facilitating pairwise comparisons and similarity type selection.
conn_icc.py triang_to_fullmat, edgewise_icc List of paths to precomputed correlation matrices as required inputs. Calculates ICC for edge-wise correlations in precomputed matrices, enhancing reliability assessment in connectivity studies.
masked_timeseries.py extract_time_series, extract_postcue_trs_for_conditions Detailed inputs required for various functions: extract_time_series, extract_postcue_trs_for_conditions, etc. Extracts and processes timeseries data from BOLD images, supporting ROI-based analysis and event-locked responses for functional MRI studies.

Conclusion

PyReliMRI simplifies the calculation of reliability metrics for MRI data, supporting both research and clinical applications. For detailed usage instructions, visit the documentation.

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

pyrelimri-2.2.2.tar.gz (27.6 kB view details)

Uploaded Source

Built Distribution

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

pyrelimri-2.2.2-py3-none-any.whl (24.3 kB view details)

Uploaded Python 3

File details

Details for the file pyrelimri-2.2.2.tar.gz.

File metadata

  • Download URL: pyrelimri-2.2.2.tar.gz
  • Upload date:
  • Size: 27.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for pyrelimri-2.2.2.tar.gz
Algorithm Hash digest
SHA256 40495770f1ddc3047eb549b661be48caf0f2a395017ca123f69ac6eaf823b825
MD5 7a78ba687e26f88a586c10f23650215b
BLAKE2b-256 a7489632f743d254a453cecfef87125fcf6aaa55ca87844518a3964c58fc9a2b

See more details on using hashes here.

File details

Details for the file pyrelimri-2.2.2-py3-none-any.whl.

File metadata

  • Download URL: pyrelimri-2.2.2-py3-none-any.whl
  • Upload date:
  • Size: 24.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for pyrelimri-2.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9a07c38e24fdd4455d92f68cb917cee2bba3c99f82b805d9abcdcc18a28ff1d4
MD5 b6bd703e8232094c31ce0958c9ad8692
BLAKE2b-256 932ba63e7818739e2fff592f32bb6c1c58867425c2a3be9b778b2cf3ca9ba5b7

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