Behavior and Neuroimaging Core User Manual
  • About
  • Infrastructure Overview
  • XNAT
    • Getting Started
    • Accessing XNAT
    • BIDS Ready Protocols
    • New XNAT projects
    • Uploading Data
    • Downloading Data
  • Demo Dataset
    • Introduction
    • How to access it
    • Protocol Information
    • Basic analysis example: checks task
  • XNAT to BIDS
    • Getting Started
    • XNAT2BIDS Software
    • Exporting to BIDS using Oscar
      • Oscar Utility Script
        • Running xnat2bids using default configuration
        • Running xnat2bids with a custom configuration
        • Syncing your XNAT project & Oscar data directory
        • Extra tools & features
      • Step-wise via Interact Session
    • BIDS Validation
      • Oscar
      • Docker
    • Converting non-MR data
      • Physiological data
      • EEG data
  • XNAT TO BIDS (Legacy)
    • Oscar SBATCH Scripts
  • BIDS and BIDS Containers
    • Introduction to BIDS
    • mriqc
    • fmriprep
    • BIDS to NIMH Data Archive (NDA)
  • Analysis Pipelines
    • Freesurfer
    • 🚧CONN Toolbox
    • FSL topup and eddy
    • Tractography: DSI Studio
    • Brown University MRS Data Collection and Preprocessing Protocol
    • LC Model
      • Installation
      • Example Run
      • Running LCModel on your own data
    • Quantitative Susceptibility Mapping (QSM)
  • Standalone Tools
    • Multi-session spectroscopy with voxalign
    • dicomsort: a tool to organize DICOM files
    • ironmap
    • convert enhanced multi-frame DICOMs to legacy single-frame
    • DICOM anonymization
  • MRF GUIDES
    • MRI simulator room
      • Motion Trainer: Balloon Task
      • Simulating scanner triggers
    • Stimulus display & response collection
    • Eyetracking at the scanner
    • Exporting data via scannershare
    • EEG in the scanner
    • Exporting spectroscopy RDA files
  • Community
    • MRF/BNC user community meetings
Powered by GitBook
On this page
  • QSM scanner protocol
  • Installing QSMxT on Oscar
  • Using QSMxT on Oscar

Was this helpful?

  1. Analysis Pipelines

Quantitative Susceptibility Mapping (QSM)

Using the QSMxT toolbox to create whole-brain quantitative magnetic susceptibility maps

PreviousRunning LCModel on your own dataNextMulti-session spectroscopy with voxalign

Last updated 5 months ago

Was this helpful?

Quantitative susceptibility mapping is a computational method that uses the magnitude and phase information from a T2*-weighted gradient recalled echo (GRE) MR sequence to quantify magnetic susceptibility across the brain. This method is useful for distinguishing between different tissue types and quantifying properties like tissue iron deposition.

A recent provides extremely helpful guidance for MR protocol design and QSM analysis methods. Here, we'll highlight one analysis method using the on Oscar.

QSM scanner protocol

Our protocol is a multi-echo (5 echoes) GRE protocol, with both the magnitude and phase data saved. Parameter choices directly follow the recommendations of the , but further tweaks might be needed depending on your specific regions of interest, etc.

For the data to automatically be converted into BIDS format with , the protocol name needs to be "" and begin with "anat-MEGRE".

Installing QSMxT on Oscar

We largely follow :

  1. In a terminal on Oscar, change to whichever directory you would like to install the QSMxT image and scripts into (I have a "scripts" directory in my home directory, but you can put it wherever you'd like).

  2. Clone the toolbox into this directory

    git clone https://github.com/NeuroDesk/transparent-singularity qsmxt_7.2.2_20241029
  3. Change directory into this new downloaded folder and run their "transparent singularity" script, which sets up your environment in a way that lets you use their tools from the command line, even though they're in a Singularity/Apptainer container

    cd qsmxt_7.2.2_20241029
    ./run_transparent_singularity.sh --container qsmxt_7.2.2_20241029.simg
    source activate_qsmxt_7.2.2_20241029.simg.sh
  4. Load the anaconda module on Oscar

    module load anaconda
  5. Create a conda environment in which the QSMxT toolbox is installed

    conda create -n qsmxt python=3.8
    conda activate qsmxt
    pip install qsmxt==7.2.2

Now, any time you want to use the QSMxT toolbox, you'll need to

module load anaconda
conda activate qsmxt

Using QSMxT on Oscar

  1. Activate your qsmxt environment

    module load anaconda
    conda activate qsmxt
  2. Launch qsmxt and give it your bids directory

    qsmxt bids
  3. Follow the interactive prompts to specify your desired outputs

  4. Choose your desired pipeline

  5. Take a look at the resulting settings; make any changes necessary, or type run to launch the analysis

  6. This will automatically create an output directory within your bids directory under /derivatives. If requested, you'll get a QSM map labeled _Chimap that looks like this!

Visit the for more details on each of these steps and possible settings, and take a look at for more information.

Get your data into valid BIDS format ( can help you with this!).

QSMxT documentation
their paper - Stewart et al., 2021 -
xnat2bids
QSM consensus paper
QSMxT toolbox
consensus paper
xnat2bids
BIDS-ready
their installation instructions for HPCs
71KB
QSM.pdf
pdf
example chimap