Skip to content

Latest commit

 

History

History
100 lines (77 loc) · 4.66 KB

README.md

File metadata and controls

100 lines (77 loc) · 4.66 KB
Raw

VesselBoost

VesselBoost is a Python-based software package utilizing deep learning techniques to segment high-resolution time-of-flight MRI angiography data, with high sensitivity towards small vessels. The software suite encompasses three essential functional modules: (1) predict, (2) test-time adaptation (TTA), and (3) boost. By leveraging these modules, users can efficiently segment high-resolution time-of-flight data or conveniently leverage our command line interface to boost segmentations for other vascular MRI image contrasts.

Table of Contents

Purpose

VesselBoost is a Python-based software package leveraging a UNet3D-based segmentation pipeline that utilizes data augmentation and test-time adaptation (TTA) to enhance segmentation quality and is generally applicable to high-resolution magnetic resonance angiograms (MRAs).
This repository contains 3 major modules:

  1. Predict. With this module, users can segment high-resolution time-of-flight using our pre-trained models. It can be used to generate intermediate proxy segmentations as well as the final ones.
  2. Test-time-adaptation. This module allows the user to provide a proxy segmentation or generate a proxy with our pre-trained model (Module 1), to drive further adaptation of the pre-trained models.
  3. Booster. Boost allows users to train a segmentation model on a single or more data using existing imperfect segmentation.

Current Version

VesselBoost 1.0.0

Requirements

  • Docker / Singularity container

Software container

VesselBoost, pre-trained models, and required software are packaged in software containers available through Dockerhub and Neurodesk.

Docker

The Dockerhub container is available at Dockerhub. To download the container, run the following command:

docker pull vnmd/vesselboost_1.0.0

Neurodesk

To predict vessel segmentation using your data and the latest version of VesselBoost on Neurodesk, you can run the following code snippet:

ml vesselboost
path_to_model=/cvmfs/neurodesk.ardc.edu.au/containers/vesselboost_1.0.0_20240815/vesselboost_1.0.0_20240815.simg/opt/VesselBoost/saved_models/
prediction.py --ds_path /path/ --out_path /path/ --pretrained "$path_to_model"/manual_0429 --prep_mode 4

For more information, please check our notebooks.

Installation

This is a Python-based software package. To successfully run this project on your local machine, please follow the following steps to set up the necessary software environment.

  1. Clone this repository to your local machine 
    git clone https://github.com/KMarshallX/VesselBoost.git
  2. Install miniconda: 
    cd VesselBoost
bash miniconda-setup.sh
  3. Then set your current working directory as the cloned repository, and install the remaining required packages 
    conda env create -f environment.yml
conda activate vessel_boost

Citation

VesselBoost paper is now published! Please cite us if you use VesselBoost in your research:

@article{xuVesselBoostPythonToolbox2024a,
  title = {{{VesselBoost}}: {{A Python Toolbox}} for {{Small Blood Vessel Segmentation}} in {{Human Magnetic Resonance Angiography Data}}},
  shorttitle = {{{VesselBoost}}},
  author = {Xu, Marshall and Ribeiro, Fernanda L. and Barth, Markus and Bernier, Micha{\"e}l and Bollmann, Steffen and Chatterjee, Soumick and Cognolato, Francesco and Gulban, Omer F. and Itkyal, Vaibhavi and Liu, Siyu and Mattern, Hendrik and Polimeni, Jonathan R. and Shaw, Thomas B. and Speck, Oliver and Bollmann, Saskia},
  year = {2024},
  month = sep,
  journal = {Aperture Neuro},
  volume = {4},
  publisher = {Organization for Human Brain Mapping},
  issn = {2957-3963},
  doi = {10.52294/001c.123217},
  urldate = {2024-09-17},
  copyright = {http://creativecommons.org/licenses/by/4.0},
  langid = {english}
}

Contact

Marshall Xu <[email protected]>

Saskia Bollmann <[email protected]>

Fernanda Ribeiro <[email protected]>