Skip to content

A workflow to allow Freesurfer recon-all to run on brain image with gliomas

License

Notifications You must be signed in to change notification settings

treanus/KUL_VBG

 
 

Repository files navigation

KUL_VBG

KUL_VBG or "KULeuven - Virtual brain grafting" enables whole brain parcellation in the presence of large lesions.

Whole brain parcellation means labeling the brain in parts, gyri, etc... Many parcellation software packages fail in the presence of large brain lesions.

The approach taken here is to:

  • Extract the gross brain lesion using a mask
  • Replace the brain lesion with normal looking tissue (hence virtual brain grafting)
  • Run parellation software like freesufer &/or fastsurfer (which only work well on non-lesioned brains)
  • Reinsert the lesion mask into the parcellation

Introduction

For reference we point to the paper published in Neuroimage, 2021 available here: https://doi.org/10.1016/j.neuroimage.2021.117731

**** We recommend you to use the "master" branch of this repository, which is the updated and more stable version of KUL_VBG. For the version corresponding to the published article, please see the branch "Orig_doi.org/10.1016/j.neuroimage.2021.117731" ****

Posing the problem and solution

An image to explain the problem: Freesurfer will not parcellate these brains

VBG fig1

The graphical solution of the VBG workflow is shown here:

VBG fig1

Using VBG

VBG was tested in Mac OSX, WSL2 on WIN11, Ubuntu 18.0, 20.04 and CentOS.

Updated Dependencies:

a) ANTs v2.3.1 and ANTsX scripts

b) FSL v6.0

c) MRtrix3 v3.0.2-64-g3eadb340

d) HD-BET

f) Freesurfer v6.0

e) FastSurfer

** Check (https://github.com/treanus/KUL_Linux_Installation.git) for help with setting up your environment with different neuroimaging packages.

Examples

Demo data is provided under /KUL_VBG/Test_data/

Example1:

KUL_VBG.sh -S PT001 -a "path_2_VBG"/KUL_VBG/Test_data/Pats/sub-PT001/sub-PT001_T1w.nii.gz -n 6 -l "path_2_VBG"/KUL_VBG/Test_data/LMs/sub-PT001_Lesion_mask -z T1 -t -B 1 -P 2 -v

*** The command above tells KUL_VBG to run for subject PT001, using the T1 images (provided as input to -S), the lesion mask specified (input to -l) is in the same space as the T1 images (input to -z). We're using HD-BET for brain extraction (-B 1), and selecting FastSurfer for parcellation (-P 2) with verbos output to command line (-v). The intermediate dir and output dir flags are omitted, which means that KUL_VBG will save intermediate outputs to the current working directory under $(pwd)/VBG_out/proc_VBG and the final outputs will be save to $(pwd)/VBG_out/output_VBG ***

Example2:

KUL_VBG.sh -S PT001 -b -n 6 -l "path_2_VBG"/KUL_VBG/Test_data/LMs/sub-PT001_Lesion_mask -z T1 -t -B 1 -P 2 -v

*** This command tells KUL_VBG to run for subject PT001, and to automatically find the input anatomical image in the BIDS directory under the current working directoy. (N.B. this can only be used if you are in the parent folder of the BIDS directoy, i.e. if you are in a folder, the BIDS folder should be visible to you). The rest is the same as example 1, except the intermediate and output directories, which by default will be placed under BIDS/derivatives/proc_VBG and output_VBG ***

Instructions

Inputs:

Obligatory: 1- Input to -S flag (subject/participant name in BIDS convetion, without the leading sub-). 2- A nifti format T1 WI of a subject (input to -a flag) 3- Binary lesion mask (lesion = 1, background = 0) integer nifti format (input to -l flag) 4- Indicate lesion mask space (input to -z flag) N.B. the specified lesion mask must have the same dimensions and transform as the input T1 WI.

Optional: 1- Specify location of intermediate processing and output folders (-m and -o flags) 2- Specify number of parallel workers used (input to -n flag) 3- Specify type of filling (default = uVBG, to activate bVBG use the -t flag) 4- Specify age group of participant (default = adult, to activate pediatric friendly mode specify the -p flag) 5- To run parcellation specify the after the lesion filling is finished, specify the -P flag with input 1=Freesurfer, 2=FastSurfer, 3=FastSurfer/FreeSurfer hybrid 6- Verbose mode = -v

Examples:

- Using the unilateral VBG approach and HD-BET for brain extraction, input data is in BIDS format with only 1 session, using FreeSurfer for parcellation
KUL_VBG.sh -S pat001 -b -n 6 -l /fullpath/lesion_T1w.nii.gz -z T1 -o /fullpath/output -B 1 -P 1 -v

- Using the bilateral VBG approach and HD-BET for brain extraction, input data is not in BIDS, using FastSurfer for parcellation
KUL_VBG.sh -S pat001 -a /fullpath/sub-PT_T1w.nii.gz -n 6 -l /fullpath/lesion_T1w.nii.gz -z T1 -o /fullpath/output -t -B 1 -P 2 -v

Purpose:

The purpose of this workflow is to generate a lesion filled image, with healthy looking synthetic tissue in place of the lesion
Essentially excising the lesion and grafting over the resulting defect in the T1 MR image space.

Required arguments:

-S:  BIDS participant name (anonymised name of the subject without the "sub-" prefix)
-b:  if data is in BIDS
-l:  full path and file name to lesion mask file per session
-z:  space of the lesion mask used (only T1 supported in this version)
-a:  Input precontrast T1WIs

Optional arguments:

-s:  session (of the participant)
-t:  Use the VBG template to derive the fill patch (if used, template tissue is used alongside native tissue to create the donor brain)
-E:  Treat as an extra-axial lesion (skip VBG bulk, fill lesion patch with 0s, run FS and subsequent steps)
-B:  specify brain extraction method (1 = HD-BET, 2 = ANTs-BET), if not set ANTs-BET will be used by default
-P:  Run parcellation (1 = FreeSurfer recon-all, 2 = FastSurfer)
-p:  In case of pediatric patients - use pediatric template (NKI_under_10 in MNI)
-m:  full path to intermediate output dir (if not set reverts to default output ./VBG_out/proc_VBG)
-o:  full path to output dir (if not set reverts to default output ./VBG_out/output_VBG)
-n:  number of cpu for parallelisation (default is 6)
-v:  show output from mrtrix commands
-h:  prints help menu

Notes:

- Input flags -b and -a are mutually exclusive, if your data is in BIDS use -b, and if not then specify exact path and name for the patient's T1.nii.gz 
- In case of trouble with HD-BET see lines (1177 - 1221)
- You need a high resolution T1 WI and a lesion mask in the same space for VBG to run
- If you end up with an empty image, it is possible you have a mismatch between the T1 and lesion mask
- The lesion mask can be generated with any lesion segmentation tool.
- The lesion mask needs to specific to the lesion with voxel values=1 encoding the lesion and 0 for the healthy tissue.

Installation instructions:

- Clone this repository, add the installation directory to your path in Bash shell.
- Ensure that all dependencies are met, FastSurfer is only required if you will use it for parcellation (i.e. with -P 2 or -P 3)

Additional scripts provided:

  1. KUL_synth_pats_4VBG.sh, which can be used to generate a cohort of synthetic patients and their ground truth.
  2. KUL_VBG_cook_template.sh, which can be used for cooking a template from two brain images with pathologies on opposing sides.

About

A workflow to allow Freesurfer recon-all to run on brain image with gliomas

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Shell 100.0%