Skip to content

utils_extractb0

extractb0

Extract a b0 volume from a DWI image.

Keywords : dwi, extract, b0


Format : tuple val(meta), path(dwi), path(bval), path(bvec)

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]
True
dwifileNifti DWI volume to perform BET + crop.True*.{nii,nii.gz}
bvalfileB-values in FSL format.True*.bval
bvecfileB-vectors in FSL format.True*.bvec

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

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]
True
*_b0.nii.gzfileb0 image(s) extracted from the DWITrue*_b0*.{nii,nii.gz}

Format : tuple val(meta), path(*_copy_dwi.bval)

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]
True
*_copy_dwi.bvalfileB-values corrected in FSL formatTrue*_copy_dwi.bval

Format : tuple val(meta), path(*_copy_dwi.bvec)

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]
True
*_copy_dwi.bvecfileB-vectors corrected in FSL formatTrue*_copy_dwi.bvec

Format : path(versions.yml)

TypeDescriptionMandatoryPattern
versions.ymlfileFile containing software versionsTrueversions.yml

TypeDescriptionDefaultChoices
extraction_strategystringExtract either: all b0 (all), mean b0 (mean), mean of each continuous cluster of b0s (cluster-mean), first b0 of each continuous cluster of b0s (cluster-first).
mean- all
- mean
- cluster-mean
- cluster-first
b0_thresholdintegerThreshold under which b-values are considered to be b0s.20
output_seriesbooleanIf output b0 volume has multiple time points, only outputs a single image instead of a numbered series of images.scil_dwi_extract_b0
False
extract_bval_bvecbooleanIf true, the command will also output bval and bvec files.False
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.


Last updated : 2026-06-26