Skip to content

reconst_freewater

freewater

Run freewater modelling pipeline using AMICO from DWI data.

Keywords : Diffusion MRI, Freewater, Microstructure modeling


Format : tuple val(meta), path(dwi), path(bval), path(bvec), path(mask), path(kernels), val(para_diff), val(iso_diff), val(perp_diff_min), val(perp_diff_max)

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]
True
dwifileNifti DWI file acquired with a freewater compatible protocol (single-shell or multi-shell).True*.{nii,nii.gz}
bvalfileB-values in FSL format.True*.bval
bvecfileB-vectors in FSL format.True*.bvec
maskfileNifti brain mask.True*mask.{nii,nii.gz}
kernelsdirectoryFolder containg kernels.Truekernels
para_difffloatParallel diffusivity value (diff prior).False
iso_difffloatIsotropic diffusivity value (diff prior).False
perp_diff_minfloatMinimum perpendicular diffusivity value (diff prior).False
perp_diff_maxfloatMaximum perpendicular diffusivity value (diff prior).False

Format : tuple val(meta), path(*__dwi_fw_corrected.nii.gz)

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]
True
*__dwi_fw_corrected.nii.gzfileNifti file freewater corrected DWI.True*__dwi_fw_corrected.{nii,nii.gz}

Format : tuple val(meta), path(*__dir.nii.gz)

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]
True
*__dir.nii.gzfileNifti file main direction.True*__dir.{nii,nii.gz}

Format : tuple val(meta), path(*__fibervolume.nii.gz)

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]
True
*__fibervolume.nii.gzfileNifti file for fiber volume.True*__fibervolume.{nii,nii.gz}

Format : tuple val(meta), path(*__fwf.nii.gz)

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]
True
*__fwf.nii.gzfileNifti file for freewater fraction (isotropic volume).True*__fwf.{nii,nii.gz}

Format : tuple val(meta), path(*__nrmse.nii.gz)

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]
True
*__nrmse.nii.gzfileNifti file for nrmse.True*__nrmse.{nii,nii.gz}

Format : path(kernels)

TypeDescriptionMandatoryPattern
kernelsdirectoryFolder containing kernels.Truekernels

Format : path(versions.yml)

TypeDescriptionMandatoryPattern
versions.ymlfileFile containing software versions.Trueversions.yml

TypeDescriptionDefaultChoices
para_difffloatAxial diffusivity (AD) in the CC. It overwrites the input para_diff if provided.
iso_difffloatMean diffusivity (MD) in ventricles (mm2/s). It overwrites the input iso_diff if provided.
perp_diff_minfloatRadial diffusivity (RD) minimum (mm2/s). It overwrites the input perp_diff_min if provided.
perp_diff_maxfloatRadial diffusivity (RD) maximum (mm2/s). It overwrites the input perp_diff_max if provided.
fw_lambda1floatFirst regularization parameter for freewater fitting.
fw_lambda2floatSecond regularization parameter for freewater fitting.
b_thrfloatLimit value to consider that a b-value is on an existing shell. Above this limit, the b-value is placed on a new shell. This includes b0s values.
compute_onlybooleanCompute kernels only.
single_threadbooleanIf true, the command will be run in single-threaded mode. By default, the command will use multiple threads based on the number of CPUs allocated to the task.False

DescriptionDOI
scilpyThe Sherbrooke Connectivity Imaging Lab (SCIL) Python dMRI processing toolbox.
FreewaterFree water elimination and mapping from diffusion MRI.10.1002/mrm.22055
AMICOAccelerated Microstructure Imaging via Convex Optimization.10.1016/j.neuroimage.2014.10.026


Last updated : 2026-04-15