Skip to main content

Multiband Artifact Regression in Simultaneous Slices (MARSS)

License: GPL v3
This is a Python version of a 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.

Metadata

Release files for MARSS 1.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for MARSS 1.0.2
File Size Uploaded
marss-1.0.2.tar.gz 19.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for MARSS 1.0.2
File Interpreter ABI Platform
marss-1.0.2-py3-none-any.whl Python 3 none any Details

Total release size: 39.2 kB

Release files / marss-1.0.2.tar.gz

Download URL marss-1.0.2.tar.gz
Size 19.4 kB
Tags Source
SHA-256 checksum
How to use checksums
e09e7b26438f6fc22244246526ca390565bbbb102ba7cb54d392f52eb1087c67
BLAKE2b-256 checksum
How to use checksums
542ae0630bd5bee4e778ed5062c04b84c949b91bfecbb0a997c1430e64ad079a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.2

Release files / marss-1.0.2-py3-none-any.whl

Download URL marss-1.0.2-py3-none-any.whl
Size 19.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fa6d6e225007a11ff867dabc88f1ed87db83fa1bd0c553c1841c344e912bdeaa
BLAKE2b-256 checksum
How to use checksums
b40334fa4d8e7f529fe02d0f617c07ff247b02b82dd5a34878e870a1de28071e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.2

Release history Release notifications | RSS feed

This release

1.0.2 This release

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page