wonsang / qMRLab

Quantitative Magnetic Resonance Imaging Made Easy with qMRLab: a Software for Data Simulation, Analysis and Visualization

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

qMRLab (beta) Build Status

qMRlab is a powerful, open source, scalable, easy to use and intuitive software for qMRI data simulation, fitting and analysis. The software consists of two parts:

  1. a qMRI data fitting and visualization interface
  2. a qMRI data simulator

qMRLab is a fork from the initial project 'qMTLab'.

For documentation, visit the 'Documentation website' If you are a developer, visit the 'Wiki page'

The simulation part allows end users to easily simulate qMRI data using analytical (or block) equations, evaluate how well these models perform under known parameters input, determine the most appropriate acquisition protocol and evaluate how fitting constraints impact the results. The data fitting part provides a simple interface to import real-world qMT data, fit them using the selected fitting procedure, visualize the fitting quality in a specific pixel, visualize the resulting parameters maps.

Please report any bug or suggestions in github.

Dependencies

  • MATLAB_R2013a or later OR
  • Octave 4.2.1 or later

Installation

Zip Download Instructions

The latest stable version of qMRLab can be downloaded freely here.

  • Extract the downloaded file to the directory you want to install qMRLab.

  • Open MATLAB, go to the qMRLab folder and run startup.

  • To start a qMRLab session, run qMRLab.

Command-Line Instructions

If you have git available on a command-line interface (e.g. Terminal on Mac OSX, Git Shell on Windows), the installation can be completed using a few quick commands.

  • In the command-line interface, navigate (cd) to the directory that you want to install qMRLab

  • Clone the directory:

git clone https://github.com/neuropoly/qMRLab.git

  • Open MATLAB, got to the qMRLab folder and run startup.

  • To start a qMRLab session, run qMRLab.

Tests

After installing the software, we recommend you evaluate all the test cases for the software.

To run all tests, from MATLAB or Octave (assuming you are already in the qMRLab directory), execute the following command.

cd Test/MoxUnitCompatible/

and run the following command:

moxunit_runtests -recursive

Citation

If you use qMRLab in you work, please cite:

Cabana, J.-F., Gu, Y., Boudreau, M., Levesque, I. R., Atchia, Y., Sled, J. G., Narayanan, S., Arnold, D. L., Pike, G. B., Cohen-Adad, J., Duval, T., Vuong, M.-T. and Stikov, N. (2016), Quantitative magnetization transfer imaging made easy with qMTLab: Software for data simulation, analysis, and visualization. Concepts Magn. Reson.. doi: 10.1002/cmr.a.21357

About

Quantitative Magnetic Resonance Imaging Made Easy with qMRLab: a Software for Data Simulation, Analysis and Visualization

License:MIT License


Languages

Language:MATLAB 87.2%Language:HTML 6.1%Language:C++ 5.6%Language:Python 0.5%Language:Java 0.3%Language:Makefile 0.2%Language:M 0.1%Language:Forth 0.0%