Skip to content

reconst_fodf

Perform FODF reconstruction and compute FODF metrics from a dwi volume for a selected number of shells. Note that multiple choices of FODF reconstruction method are available through the method argument. The single-shell single-tissue (ssst) method is performed by selecting only one shell (task.ext.fodf_shells) and choosing the ssst method (task.ext.method). The multi-shell single-tissue (msst) method (default) is performed by selecting multiple shells (task.ext.fodf_shells) and choosing the ssst method (task.ext.method). Both ssst and msst are expected to output only WM FODF. The multi-shell multi-tissue (msmt) method is performed by selecting multiple shells (task.ext.fodf_shells) and choosing the msmt method (task.ext.method). The msmt method is expected to output WM FODF, GM FODF and CSF FODF, along with volume fraction (vf) maps. In every case, chosen FODF metrics are outputed.

Keywords : FODF, Local Model, Reconst


Format : tuple val(meta), path(dwi), path(bval), path(bvec), path(mask), path(fa), path(md), path(wm_frf), path(gm_frf), path(csf_frf)

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]True
dwifileNifti DWI volume to reconstruct FODF from.True*.{nii,nii.gz}
bvalfileB-values in FSL format.True*.bval
bvecfileB-vectors in FSL format.True*.bvec
maskfileB0 mask.True*.{nii,nii.gz}
fafileFA map.True*.{nii,nii.gz}
mdfileMD map.True*.{nii,nii.gz}
wm_frffileFiber Response Function (FRF) for the white matter (WM). In the case of single-shell method, this should be the only input FRF. In the case of multi-shell method, gm_frf and csf_frf are also mandatory.True*.txt
gm_frffileFiber Response Function (FRF) for the grey matter (GM). Only use with multi-shell method, along with wm_frf and csf_frf.True*.txt
csf_frffileFiber Response Function (FRF) for the CSF. Only use with multi-shell method, along with wm_frf and gm_frf.True*.txt

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

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]True
*__fodf.nii.gzfileFODF map.True*__fodf.nii.gz

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

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]True
*__wm_fodf.nii.gzfileWM FODF map.True*__wm_fodf.nii.gz

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

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]True
*__gm_fodf.nii.gzfileGM FODF map.True*__gm_fodf.nii.gz

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

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]True
*__csf_fodf.nii.gzfileCSF FODF map.True*__csf_fodf.nii.gz

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

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]True
*__vf.nii.gzfileVolume fraction map.True*__vf.nii.gz

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

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]True
*__vf_rgb.nii.gzfileVolume fraction map in rgb.True*__vf_rgb.nii.gz

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

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]True
*__peaks.nii.gzfilePeaks file.True*__peaks.nii.gz

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

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]True
*__peak_values.nii.gzfilePeak values file.True*__peak_values.nii.gz

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

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]True
*__peak_indices.nii.gzfilePeak indices file.True*__peak_indices.nii.gz

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

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]True
*__afd_max.nii.gzfileMaximum Apparent Fiber Density (AFDmax) map.True*__afd_max.nii.gz

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

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]True
*__afd_total.nii.gzfileTotal Apparent Fiber Density (AFDtotal) map.True*__afd_total.nii.gz

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

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]True
*__afd_sum.nii.gzfileSum of all Apparent Fiber Density (Afdsum) map.True*__afd_sum.nii.gz

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

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]True
*__nufo.nii.gzfileNumber of Fiber Orientation (NuFO) map.True*__nufo.nii.gz

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

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]True
*__ventricles_mask.nii.gzfileVentricule mask estimated from an MD and FA threshold.True*__ventricles_mask.nii.gz

Format : path(versions.yml)

TypeDescriptionMandatoryPattern
versions.ymlfileFile containing software versionsTrueversions.yml

TypeDescriptionDefaultChoices
dwi_shell_toleranceintegerTolerance in s/mm2 for grouping b-values into shells. E.g. with a tolerance of 20, b-values between 0 and 20 will be considered as b=0.None
min_fodf_shell_valueintegerMinimum b-value to use for FODF fitting. All shells above this value will be used.100
b0_thr_extract_b0integerThreshold under which b-values are considered to be b0s.10
fodf_shellsstringSpace separated list of b-values to use for FODF fitting. If None, all shells above min_fodf_shell_value will be used.None
sh_orderintegerSpherical harmonics order to use for FODF fitting.None
sh_basisstringSpherical harmonics basis to use for FODF fitting.None- tournier07
- descoteaux07
- descoteaux07_legacy
- tournier07_legacy
methodstringFODF reconstruction method to use.ssst- ssst
- msmt
relative_thresholdfloatRelative threshold to apply on FODF peaks.None
fodf_metrics_a_factorfloatAbsolute threshold to apply on FODF peaks.2.0
fa_thresholdfloatThreshold to apply on the FA map to extract voxels in ventricles.None
md_thresholdfloatThreshold to apply on the MD map to extract voxels in ventricles.None
absolute_peaksbooleanIf set, the peak values are not max-normalized for each voxel, but kept as the actual fODF amplitude.False
wm_fodfbooleanIf set, will output the white matter (WM) FODF map when using the msmt method.True
gm_fodfbooleanIf set, will output the grey matter (GM) FODF map when using the msmt method.False
csf_fodfbooleanIf set, will output the CSF FODF map when using the msmt method.False
vfbooleanIf set, will output the volume fraction (vf) maps when using the msmt method.False
vf_rgbbooleanIf set, will output the volume fraction (vf) maps in rgb when using the msmt method.False
peaksbooleanIf set, will output the peaks file.False
peak_valuesbooleanIf set, will output the peak values file.False
peak_indicesbooleanIf set, will output the peak indices file.False
afd_maxbooleanIf set, will output the maximum Apparent Fiber Density (AFDmax) map.False
afd_totalbooleanIf set, will output the total Apparent Fiber Density (AFDtotal) map.False
afd_sumbooleanIf set, will output the sum of all Apparent Fiber Density (Afdsum) map.False
nufobooleanIf set, will output the Number of Fiber Orientation (NuFO) map.False
ventricles_maskbooleanIf set, will output the ventricle mask estimated from an MD and FA threshold.False

DescriptionDOI
scilpyThe Sherbrooke Connectivity Imaging Lab (SCIL) Python dMRI processing toolbox.


Last updated : 2025-10-30