Skip to content

bundle_labelmap

Compute the label image (Nifti) from a centroid and tractograms (all representing the same bundle). The label image represents the coverage of the bundle, segmented into regions labelled from 0 to —nb_pts, starting from the head, ending in the tail. Each voxel will have the label of its nearest centroid point. The number of labels will be the same as the centroid’s number of points.

Keywords : bundle, distance, label, centroid


Format : tuple val(meta), path(bundles), path(centroids)

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]True
bundlesfileList of trk files of the bundlesTrue*.{trk}
centroidsfileList of trk files of the centroidsTrue*.{trk}

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

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]True
*_labels.nii.gzfileLabels map, each pixel intensity corresponds to the label of the nearest centroid.True*_labels.nii.gz

Format : tuple val(meta), path(*_labels.trk)

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]True
*_labels.trkfileColored by labels bundle file. The streamline color corresponds to the label of the nearest centroid.True*_labels.trk

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

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]True
*_distances.nii.gzfileDistance map. The pixel intensity corresponds to the distance to the nearest centroid.True*_distances.nii.gz

Format : tuple val(meta), path(*_distances.trk)

TypeDescriptionMandatoryPattern
metamapGroovy Map containing sample information e.g. [ id:'test', single_end:false ]True
*_distances.trkfileColored by distance bundle file. The streamline color corresponds to the distance to the nearest centroid.True*_distances.trk

Format : path(versions.yml)

TypeDescriptionMandatoryPattern
versions.ymlfileFile containing software versionsTrueversions.yml

TypeDescriptionDefaultChoices
nb_pointsintNumber of divisions for the bundles.Number of points of the centroid
colormapstringSelect the colormap for colored trk (data_per_point).jet
new_labellingbooleanUse the new labelling method (multi-centroids).False

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


Last updated : 2025-10-30