Skip to content

dtimetrics

Module: reconst/dtimetrics

Script to compute all of the Diffusion Tensor Imaging (DTI) metrics

Inputs

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]true
dwifileNifti DWI volume used to extract DTI metrics.true*.{nii,nii.gz}
bvalfileB-values in FSL format.true*.bval
bvecfileB-vectors in FSL format.true*.bvec
b0maskfileNifti b0 volume file used to mask the input image.false*.{nii,nii.gz}

Arguments

TypeDescriptionChoicesDefault
dwi_shell_toleranceintTolerance for the shell detection algorithm.20
max_dti_shell_valueintMaximum value for the DTI shell.1500
b0_thr_extract_b0intThreshold for the b0 extraction.0
b0_thresholdintThreshold for the b0 mask.0
dti_shellsstringList of b-values to use for the DTI computation.0 1000
b0maskbooleanUse the b0 mask to mask the input image.True
adbooleanCompute the axial diffusivity.True
evecsbooleanCompute the eigenvectors of the tensor.True
evalsbooleanCompute the eigenvalues of the tensor.True
fabooleanCompute the fractional anisotropy.True
gabooleanCompute the geodesic anisotropy.True
rgbbooleanCompute the colored fractional anisotropy.True
mdbooleanCompute the mean diffusivity.True
modebooleanCompute the mode.True
normbooleanCompute the tensor norm.True
rdbooleanCompute the radial diffusivity.True
tensorbooleanCompute the tensor coefficients.True
nonphysicalbooleanCompute the nonphysical voxels.True
pulsationbooleanCompute the pulsation.True
residualbooleanCompute the residual.True

Outputs

TypeDescriptionPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]
adfileOutput filename for the axial diffusivity.*__ad.{nii,nii.gz}
evecsfileOutput filename for the eigenvectors of the tensor.*__evecs.{nii,nii.gz}
evecs_v1fileOutput filename for the first eigenvector.*__evecs_v1.{nii,nii.gz}
evecs_v2fileOutput filename for the second eigenvector.*__evecs_v2.{nii,nii.gz}
evecs_v3fileOutput filename for the third eigenvector.*__evecs_v3.{nii,nii.gz}
evalsfileOutput filename for the eigenvalues of the tensor.*__evals.{nii,nii.gz}
evals_e1fileOutput filename for the first eigenvalue.*__evals_e1.{nii,nii.gz}
evals_e2fileOutput filename for the second eigenvalue.*__evals_e2.{nii,nii.gz}
evals_e3fileOutput filename for the third eigenvalue.*__evals_e3.{nii,nii.gz}
fafileOutput filename for the fractional anisotropy.*__fa.{nii,nii.gz}
gafileOutput filename for the geodesic anisotropy.*__ga.{nii,nii.gz}
rgbfileOutput filename for the colored fractional anisotropy.*__rgb.{nii,nii.gz}
mdfileOutput filename for the mean diffusivity.*__md.{nii,nii.gz}
modefileOutput filename for the mode.*__mode.{nii,nii.gz}
normfileOutput filename for the tensor norm.*__norm.{nii,nii.gz}
rdfileOutput filename for the radial diffusivity.*__rd.{nii,nii.gz}
tensorfileOutput filename for the tensor coefficients.*__tensor.{nii,nii.gz}
nonphysicalfileOutput filename for the voxels with physically implausible signals where the mean of b=0 images is below one or more diffusion-weighted images.*__nonphysical.{nii,nii.gz}
pulsation_std_dwifileStandard deviation map across all diffusion-weighted images. Shows pulsation and misalignment artifacts.*__pulsation_std_dwi.{nii,nii.gz}
pulsation_std_b0fileStandard deviation map across b=0 images if more than one is available. Shows pulsation and misalignment artifacts.*__pulsation_std_b0.{nii,nii.gz}
residualfileOutput filename for the map of the residual of the tensor fit.*__residual.{nii,nii.gz}
residual_iqr_residualsfileOutput filename for the interquartile range of the residual of the tensor fit.*__residual_iqr_residuals.npy
residual_mean_residualsfileOutput filename for the mean of the residual of the tensor fit.*__residual_mean_residuals.npy
residual_q1_residualsfileOutput filename for the firt quartile of the residual of the tensor fit.*__residual_q1_residuals.npy
residual_q3_residualsfileOutput filename for the third quartile of the residual of the tensor fit.*__residual_q3_residuals.npy
residual_residuals_statsfileOutput filename for the all statistics of the residual of the tensor fit.*__residual_residuals_stats.png
residual_std_residualsfileOutput filename for the standard deviation of the residual of the tensor fit.*__residual_std_residuals.npy
mqcfile.png file containing screenshots of some DTI metrics. Made for use in MultiQC report.*__dti_mqc.png
versionsfileFile containing software versionsversions.yml

Tools

DescriptionHomepageDOI
scilpyThe Sherbrooke Connectivity Imaging Lab (SCIL) Python dMRI processing toolbox.https://github.com/scilus/scilpy.git

Authors

@scilus