image_burnvoxels
- Burning Voxels: The module takes binary masks and “burns” or imprints their voxels onto an anatomical image. This means that the areas defined by the masks are marked or labeled on the anatomical image.
- Output Images: The module generates multiple output images:
- One image with all masks burned onto the anatomical image.
- Separate images for each mask burned onto the anatomical image. If there are N masks, there will be N images.
- Label Values: The burned voxels are assigned label values:
- The minimum label value is 25.
- Subsequent label values are incremented by a dynamically determined step based on the number of masks. In summary, this module processes an anatomical image by applying binary masks to it, generating multiple labeled images as output.
Keywords : Image Processing, Voxel Burning, Mask Application
Inputs
Section titled “Inputs”Input 1
Section titled “Input 1”Format : tuple val(meta), val(masks), path(anat)
| Type | Description | Mandatory | Pattern | |
|---|---|---|---|---|
| meta | map | Groovy Map containing sample information e.g. [ id:'sample1', single_end:false ] | True | |
| masks | list | List of binary masks to be burned onto the anatomical image. | True | *.nii.gz |
| anat | file | Anatomical image to burn the masks onto. | True | *.nii.gz |
Outputs
Section titled “Outputs”all_masks_burned
Section titled “all_masks_burned”Format : tuple val(meta), val(*__all.nii.gz)
| Type | Description | Mandatory | Pattern | |
|---|---|---|---|---|
| meta | map | Groovy Map containing sample information e.g. [ id:'sample1', single_end:false ] | True | |
| *__all.nii.gz | map | Anatomical image with all masks burned onto it. | True | *.nii.gz |
each_mask_burned
Section titled “each_mask_burned”Format : tuple val(meta), val(*__*_[0-9]*[0-9].nii.gz)
| Type | Description | Mandatory | Pattern | |
|---|---|---|---|---|
| meta | map | Groovy Map containing sample information e.g. [ id:'sample1', single_end:false ] | True | |
| ___[0-9]*[0-9].nii.gz | map | Anatomical image with each mask burned onto it. | True | *__*_[0-9]*[0-9].nii.gz |
versions
Section titled “versions”Format : path(versions.yml)
| Type | Description | Mandatory | Pattern | |
|---|---|---|---|---|
| versions.yml | file | File containing software versions | True | versions.yml |
| Description | DOI | |
|---|---|---|
| ANTs | Advanced Normalization Tools (ANTs) for image processing. | 10.1038/s41598-021-87564-6 |
| MRtrix3 | MRtrix3 is a software package for various types of diffusion imaging data, including diffusion-weighted, diffusion-tensor, and q-ball imaging. | 10.1016/j.neuroimage.2019.116137 |
| scilpy | The Sherbrooke Connectivity Imaging Lab (SCIL) Python dMRI processing toolbox. |
Authors
Section titled “Authors”Last updated : 2025-10-30