mwf : Myelin Water Fraction from Multi-Exponential T2w data¶


% This m-file has been automatically generated using qMRgenBatch(mwf)
% for publishing documentation.
% Command Line Interface (CLI) is well-suited for automatization
% purposes and Octave.
% Please execute this m-file section by section to get familiar with batch
% processing for mwf on CLI.
% Demo files are downloaded into mwf_data folder.
% Written by: Agah Karakuzu, 2017
% ==============================================================================

1. Print mwf information

  mwf :  Myelin Water Fraction from Multi-Exponential T2w data


MET2data    Multi-Exponential T2 data
(Mask)        Binary mask to accelerate the fitting (OPTIONAL)

MWF       Myelin Wanter Fraction
T2MW      Spin relaxation time for Myelin Water (MW) [ms]
T2IEW     Spin relaxation time for Intra/Extracellular Water (IEW) [ms]

Cutoff          Cutoff time [ms]
Sigma           Noise standard deviation. Currently not corrected for rician bias
Relaxation Type
'T2'       For a SE sequence
'T2*'      For a GRE sequence

MET2data   [TE1 TE2 ...] % list of echo times [ms]

Example of command line usage:
Model = mwf;  % Create class from model
data = struct;  % Create data structure
data.MET2data ='MET2data.mat';  % Load data
data.Mask = 'Mask.mat';
FitResults = FitData(data,Model); %fit data

For more examples: qMRusage(mwf)

Author: Ian Gagnon, 2017

Please cite the following if you use this module:
MacKay, A., Whittall, K., Adler, J., Li, D., Paty, D., Graeb, D.,
1994. In vivo visualization of myelin water in brain by magnetic
resonance. Magn. Reson. Med. 31, 673?677.
In addition to citing the package:
Karakuzu A., Boudreau M., Duval T.,Boshkovski T., Leppert I.R., Cabana J.F.,
Gagnon I., Beliveau P., Pike G.B., Cohen-Adad J., Stikov N. (2020), qMRLab:
Quantitative MRI analysis, under one umbrella doi: 10.21105/joss.02343

Reference page in Doc Center
doc mwf

2. Setting model parameters

2.a. Create mwf object

Model = mwf;

2.b. Set protocol and options

Protocol: MRI acquisition parameters that are accounted for by the respective model.

For example: TE, TR, FA FieldStrength. The assigned protocol values are subjected to a sanity check to ensure that they are in agreement with the data attributes.

Options: Fitting preferences that are left at user's discretion.

For example: linear fit, exponential fit, drop first echo.

2.b.1 Set protocol the CLI way

If you are using Octave, or would like to serialize your operations any without GUI involvement, you can assign protocol directly in CLI:

EchoTime  = [10.0000; 20.0000; 30.0000; 40.0000; 50.0000; 60.0000; 70.0000; 80.0000; 90.0000; 100.0000; 110.0000; 120.0000; 130.0000; 140.0000; 150.0000; 160.0000; 170.0000; 180.0000; 190.0000; 200.0000; 210.0000; 220.0000; 230.0000; 240.0000; 250.0000; 260.0000; 270.0000; 280.0000; 290.0000; 300.0000; 310.0000; 320.0000];
% EchoTime (ms) is a vector of [32X1]
Model.Prot.MET2data.Mat = [ EchoTime ];

  See the generic notes section below for further information.

2.b.2 Set protocol and options the GUI way

The following command opens a panel to set protocol and options (if GUI is available to the user):

Model = Custom_OptionsGUI(Model);

If available, you need to close this panel for the remaining of the script to proceed.

  Using this panel, you can save qMRLab protocol files that can be used in both interfaces. See the generic notes section below for details.

3. Fit MRI data

3.a. Load input data

This section shows how you can load data into a(n) mwf object.

  • At the CLI level, qMRLab accepts structs containing (double) data in the fields named in accordance with a qMRLab model.

  See the generic notes section below for BIDS compatible wrappers and scalable
      qMRLab workflows.

%          |- mwf object needs 2 data input(s) to be assigned:
%          |-   MET2data
%          |-   Mask

data = struct();

% MET2data.mat contains [64  64   1  32] data.
% Mask.mat contains [64  64] data.
data.MET2data= double(MET2data);
data.Mask= double(Mask);

3.b. Execute fitting process

This section will fit the loaded data.

FitResults = FitData(data,Model,0);

Visit the generic notes section below for instructions to accelerate fitting by
      parallelization using ParFitData.

3.c. Display FitResults

You can display the current outputs by:


A representative fit curve will be plotted if available.

To render images in this page, we will load the fit results that had been saved before. You can skip the following code block;

% Load FitResults that comes with the example dataset.
FitResults_old = load('FitResults/FitResults.mat');

3.d. Save fit results

Outputs can be saved as *.nii.(gz) if NIfTI inputs are available:

% Generic function call to save nifti outputs
FitResultsSave_nii(FitResults, 'reference/nifti/file.nii.(gz)');

If not, FitResults.mat file can be saved. This file contains all the outputs as workspace variables:

% Generic function call to save FitResults.mat

  FitResults.mat files can be loaded to qMRLab GUI for visualization and ROI

The section below will be dynamically generated in accordance with the example data format (mat or nii). You can substitute FitResults_old with FitResults if you executed the fitting using example dataset for this model in section 3.b..


3.e. Re-use or share fit configuration files

qMRLab's fit configuration files (mwf_Demo.qmrlab.mat) store all the options and protocol in relation to the used model and the release version.

  *.qmrlab.mat files can be easily shared with collaborators to allow them fit their own
      data or run simulations using identical option and protocol configurations.


4. Simulations

4.a. Single Voxel Curve

Simulates single voxel curves
  1. Analytically generate synthetic MRI data
  2. Add rician noise
  3. Fit and plot the respective curve

      x = struct;
x.MWF = 50.0001;
x.T2MW = 20.0001;
x.T2IEW = 120;
% Set simulation options
Opt.SNR = 200;
Opt.T2Spectrumvariance_Myelin = 5;
Opt.T2Spectrumvariance_IEIntraExtracellularWater = 20;
% run simulation
figure('Name','Single Voxel Curve Simulation');
FitResult = Model.Sim_Single_Voxel_Curve(x,Opt);

4.b. Sensitivity Analysis

Simulates sensitivity to fitted parameters
  1. Iterate fitting parameters from lower (lb) to upper (ub) bound
  2. Run Sim_Single_Voxel_Curve for Nofruns times
  3. Compute the mean and std across runs

            MWF           T2MW          T2IEW = [50            20            1.2e+02]; % nominal values
OptTable.fx = [0             1             1]; %vary MWF... = [0.0001        0.0001        40]; %...from 0.0001
OptTable.ub = [1e+02         40            2e+02]; 100
% Set simulation options
Opt.SNR = 200;
Opt.T2Spectrumvariance_Myelin = 5;
Opt.T2Spectrumvariance_IEIntraExtracellularWater = 20;
Opt.Nofrun = 5;
% run simulation
SimResults = Model.Sim_Sensitivity_Analysis(OptTable,Opt);
figure('Name','Sensitivity Analysis');
SimVaryPlot(SimResults, 'MWF' ,'MWF' );

5. Notes

5.a. Notes specific to mwf

5.a.1 BIDS

|== sub-01/
|~~~~~~ anat/
|---------- sub-01_echo-1_MESE.json
|---------- sub-01_echo-1_MESE.nii.gz
|---------- sub-01_echo-2_MESE.json
|---------- sub-01_echo-2_MESE.nii.gz
|---------- .
|---------- .
|---------- sub-01_echo-N_MESE.json
|---------- sub-01_echo-N_MESE.nii.gz
|== derivatives/
|~~~~~~ qMRLab/
|---------- dataset_description.json
|~~~~~~~~~~ sub-01/anat/
|-------------- sub-01_MWFmap.nii.gz
|-------------- sub-01_MWFmap.json
|-------------- sub-01_T2MW.nii.gz (Not defined in BIDS yet)
|-------------- sub-01_T2MW.json
|-------------- sub-01_T2IEW.nii.gz (Not defined in BIDS yet)
|-------------- sub-01_T2IEW.json

For further information, please visit BIDS qMRI Appendix.

5.b. Generic notes

5.b.1. Batch friendly option and protocol conventions

If you would like to load a desired set of options / protocols programatically, you can use *.qmrlab.mat files. To save a configuration from the protocol panel of mwf, first open the respective panel by running the following command in your MATLAB command window (MATLAB only):


In this panel, you can arrange available options and protocols according to your needs, then click the save button to save my_mwf.qmrlab.mat file. This file can be later loaded into a mwf object in batch by:

Model = mwf;
Model = Model.loadObj('my_mwf.qmrlab.mat');

  Model.loadObj('my_mwf.qmrlab.mat') call won't update the fields in the Model object, unless the output is assigned to the object as shown above. This compromise on convenience is to retain Octave CLI compatibility.

If you don't have MATLAB, hence cannot access the GUI, two alternatives are available to populate options:

  1. Use qmrlab/mcrgui:latest Docker image to access GUI. The instructions are available here.
  2. Set options and protocols in CLI:
  • List available option fields using tab completion in Octave's command prompt (or window)
Model = mwf;
Model.option. % click the tab button on your keyboard and list the available fields.
  • Assign the desired field. For example, for a mono_t2 object:
Model = mono_t2;
Model.options.DropFirstEcho = true;
Model.options.OffsetTerm = false;

Some option fields may be mutually exclusive or interdependent. Such cases are handled by the GUI options panel; however, not exposed to the CLI. Therefore, manual CLI options assignments may be challenging for some involved methods such as qmt_spgr or qsm_sb. If above options are not working for you and you cannot infer how to set options solely in batch, please feel free to open an issue in qMRLab and request the protocol file you need.

Similarly, in CLI, you can inspect and assign the protocols:

Model = mwf;
Model.Prot. % click the tab button on your keyboard and list the available fields.

Each protocol field has two subfields of Format and Mat. The first one is a cell indicating the name of the protocol parameter (such as EchoTime (ms)) and the latter one contains the respective values (such as 30 x 1 double array containing EchoTimes).

The default Mat protocol values are set according to the example datasets served via OSF.

5.b.2 Parallelization

Beginning from release 2.5.0, you can accelerate fitting for the voxelwise models using parallelization.

Available in MATLAB only. Requires parallel processing toolbox.

In CLI, you can perform parallel fitting by:

FitResults = ParFitData(data,Model);

If a parpool exists, the ParFitData will use it. If not, a new pool will be created using the local profile. By default, ParFitData saves outputs automatically every 5 minutes. You can disable this feature by:

FitResults = ParFitData(data, Model, 'AutosaveEnabled', false);

Alternatively, you can change the autosave interval (min 1 min) by:

FitResults = ParFitData(data,Model,'AutoSaveInterval',10);

If something went wrong during the fitting (e.g. your computer had to be restarted), you can recover the autosaved data by:

FitResults = ParFitData(data,Model,'RecoverDirectory','/ParFitTempResults_*/folder/from/the/previous/session');

GUI users will be prompted a question about whether they would like to use parallelization after clicking the Fit Data button, if the conditions are met. When called from GUI, ParFitData will be run with default options:

  • Save temporary results every 5 minutes or whenever a chunk has finished processing
  • Split data into chunks with a granularity factor of 3
  • Do not remove temporary fit results upon completion

For further information:

help ParFitData

The default parallelization options can be changed in the preferences.json file located at the root qMRLab directory.

6. Citations

qMRLab JOSS article

Karakuzu A., Boudreau M., Duval T.,Boshkovski T., Leppert I.R., Cabana J.F., Gagnon I., Beliveau P., Pike G.B., Cohen-Adad J., Stikov N. (2020), qMRLab: Quantitative MRI analysis, under one umbrella 10.21105/joss.02343

Reference article for mwf

MacKay, M., et al. (1994). In vivo visualization of myeling water in brain by magnetic resonance. Magnetic Resonance in Medicine, 31(6), 673-677. 10.1002/mrm.1910310614

Quantitative MRI, under one umbrella.

| qMRPullseq | qMRFlow | Interactive Tutorials |

NeuroPoly Lab, Montreal, Canada