Skip to main content

MARSS is a regression-based method that mitigates an artifactual shared signal between simultaneously acquired slices in unprocessed MB fMRI.

Project description

Multiband Artifact Regression in Simultaneous Slices (MARSS)

License: GPL v3
This is a Python version of a MATLAB pipeline developed for use in simultaneous multi-slice (multiband; MB) fMRI data.
MARSS is a regression-based method that mitigates an artifactual shared signal between simultaneously acquired slices in unprocessed MB fMRI.
Software Authors: Philip N. Tubiolo, John C. Williams, Ashley Zhao, and Jared X. Van Snellenberg

Accompanies the following manuscript:
Tubiolo PN, Williams JC, Van Snellenberg JX.
Characterization and Mitigation of a Simultaneous Multi-Slice fMRI Artifact: Multiband Artifact Regression in Simultaneous Slices.
Hum Brain Mapp. 2024 Nov;45(16):e70066. doi: 10.1002/hbm.70066. PMID: 39501896; PMCID: PMC11538719.

Software Requirements

FSL must be installed and included in the system's PATH prior to use. For more information, visit https://fsl.fmrib.ox.ac.uk/fsl/docs/#/
This software has been tested on the following operating systems, but should be compatible with MacOS as well:
Linux: Red Hat Enterprise Linux 7.9
Windows: Windows 10 Home 64-bit

Hardware Requirements

MARSS should only require the minimum RAM to handle a single fMRI timeseries (approximately 2GB). However, it has been tested with these minimum specifications:
RAM: 16 GB
Processor: Intel(R) Core(TM) i7-10750H CPU @ 2.60GHz

With the above specifications, the total time taken for MARSS to complete on a single fMRI timeseries of 563 volumes is approximately 10 minutes.

Usage

Installation

To install this package, run the following command:

pip install MARSS

MARSS_main

MARSS_main is the main function of this pipeline, and the only function that must be directly run in order to perform MARSS on a single timeseries.

Syntax

MARSS_main(timeseriesFile, MB, workingDir,*args) performs MARSS artifact correction on a single unprocessed, MB fMRI timeseries.

Input Arguments

timeseriesFile (string): Full path to unprocessed, MB fMRI timeseries
MB (double): Multiband Acceleration Factor used during image acquisition
workingDir (string): Parent directory for all MARSS outputs. MARSS will create a separate folder within this folder named after timeseriesFile.
*args (string): Optional argument specifying a path to motion parameters.

Outputs in workingDir

za_.nii: this NIFTI is the MARSS corrected timeseries.
_slcart.nii: this NIFTI is the timeseries of MARSS-estimated artifact signal that was subtracted from timeseriesFile to produce za*.nii
_AVGslcart.nii: this NIFTI is the mean absolute value across timepoints of slcart.nii (shown as a single 3D volume).
corrMatrix*.png: slice correlation matrix of pre-MARSS data, along with the average difference in pearson correlation between simultaneously acquired slices and adjacent-to-simultaneous slices.
corrMatrixza*.png: slice correlation matrix of MARSS-corrected data.

Citation

When using MARSS, please cite the following:
Tubiolo PN, Williams JC, Van Snellenberg JX.
Characterization and Mitigation of a Simultaneous Multi-Slice fMRI Artifact: Multiband Artifact Regression in Simultaneous Slices.
Hum Brain Mapp. 2024 Nov;45(16):e70066. doi: 10.1002/hbm.70066. PMID: 39501896; PMCID: PMC11538719.

License

This software is released under the GNU General Public License Version 3.

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

marss-1.0.0.tar.gz (19.1 kB view details)

Uploaded Source

Built Distribution

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

MARSS-1.0.0-py3-none-any.whl (19.5 kB view details)

Uploaded Python 3

File details

Details for the file marss-1.0.0.tar.gz.

File metadata

  • Download URL: marss-1.0.0.tar.gz
  • Upload date:
  • Size: 19.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.18

File hashes

Hashes for marss-1.0.0.tar.gz
Algorithm Hash digest
SHA256 256284123a58b8029b8000445152bc8e36ab75a10bc255095f1d258779e391a4
MD5 7aa8581c45eeb5cb5e03c4d09de243c9
BLAKE2b-256 a87a95c271ed0bfcdeb91688165a1418dc76f76dbfa79b87e460c903c0a59ab5

See more details on using hashes here.

File details

Details for the file MARSS-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: MARSS-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 19.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.18

File hashes

Hashes for MARSS-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dbf54088bb951a1a31dc9a4c91285ad5334f19ac4b1a3184ace53d02bda2ce34
MD5 a40c3b04fd4acc68cc8c7dc142e1f451
BLAKE2b-256 9a434a2896871e1a97892b89343e7282404edb26fb76cbb32240bd3c882cf07f

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