Skip to content

metricsinroi

Module: stats/metricsinroi

Module to compute statistics (mean, std) of scalar maps (metrics), which can represent diffusion metrics, in ROIs or labels.

Inputs

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]true
metricsfileMetrics volume(s) in Nifti*.{nii,nii.gz}
roisfileROI or Label volume(s) in Nifti*.{nii,nii.gz}
rois_lutfileLUT file corresponding to labels, used to name the regions of interest*.{nii,nii.gz}

Arguments

TypeDescriptionChoicesDefault
suffixstringIt will add an extra string before “_stats.json”
binbooleanIf set, will consider every value of the mask higherthan 0 to be part of the mask (equivalent weighting for every voxel). It will be used if use_label is false.False
normalize_weightsbooleanIf set, the weights will be normalized to the [0,1] range. It will be used if use_label is false.False
use_labelbooleanIf set, rois image will be considered as a label image with multiple indices.False

Outputs

TypeDescriptionPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]
mqcfileJSON file containing mean/std per pair of roi/metrics or label/metrics*__stats.json
versionsfileFile containing software versionsversions.yml

Tools

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

Authors

@arnaudbore