From 85164e7a1d78aa5901c9534e58cd4b3f881b5344 Mon Sep 17 00:00:00 2001 From: abelsalm Date: Thu, 31 Oct 2024 10:35:06 -0400 Subject: [PATCH] readme updated --- README.md | 34 ++++++---------------------------- 1 file changed, 6 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 90e1aef..81268e4 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,10 @@ -# Installation -Pour utiliser le code de segmentation du canal spinal à partir des segmentations de la moelle et du CSF il est nécessaire d'installer les librairies utilisées. la ligne qui permet d'installer ces librairie est incluse dans celles pour cloner le Github. -Ensuite, il faut cloner le Github à l'aide de la suite de commande suivante : -~~~ -git clone https://github.com/ivadomed/model-csf-seg.git -cd model-csg-seg -pip install -r requirements.txt -~~~ +# Automatic segmentation of spinal canal -# Fonctionnement -À partir de la segmentation de la moelle, le centre de masse est déterminé pour chaque tranche transversale. -- Si il n'y as pas de segmentation du CSF (le CSF n'apparait pas sur l'image), on ne remplace pas l'image. -- Si il n'y as pas de segmentation de la moelle, on met l'image à 0. -- Si le CSF et la moelle on des segmentations sur la tranche, un floodfill est fait à partir du centre de masse déterminé plus haut. -- Le code évalue ensuite si l'image est pleine de 1 (région non fermée lors du floodfill) -- Si l'image est pleine de 1, on reprend l'image de base et on fait une fermeture. -- Le fait de faire la fermeture sur certaines images ne semble pas causée d'ajout de bruit à l'extérieur du CSF selon ce que j'ai observé. +This repository contains the code for deep learning-based segmentation of the spinal canal. +The code is based on the [nnUNet framework](https://github.com/MIC-DKFZ/nnUNet). -# Utilisation -Le code prend en entrée 3 arguments -* `-i`: Segmentation du CSF (.nii.gz) +The spinal canal as here been defined using the anatomical boundary of the dural sac. The model has been trained to segment both spinal cord and CSF inside the dural sac. -* `-s`: Segmentation de la moelle épinière (.nii.gz) - -* `-o` Le nom que vous souhaiter donner au fichier (.nii.gz) - -Voici donc un exemple de commande pour utiliser la fonction : -~~~ -python3 fill-csf.py -i -s -o -~~~ - +## Model Overview +The model is a 3d nnUNet which was trained specifically on T2-weighted images and provides and provides a segmentation of the spinal canal. \ No newline at end of file