Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Addressing #4. Thanks for the feedback @jcohenadad
  • Loading branch information
sriosq committed Jul 4, 2024
1 parent 1aad131 commit 6c2cfb8
Showing 1 changed file with 26 additions and 6 deletions.
32 changes: 26 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,35 @@ A parcellation color map for ITK-snap is provided [here](parcellation_itk.txt).

# Adding Labels - Modified Nifti
One of the current limitations of the output from Total Segmentator is the label definition for the Spinal Cord. This encouraged us to add new labels to the phantom. </br>
In the following jupyter notebook you will find the instructions to create new labels as well as manually adding the labels to the dictionary that holds all the MR property values.
In the following jupyter [notebook](https://github.com/shimming-toolbox/tissue-to-MRproperty/blob/main/interactive.ipynb) you will find the instructions to create new labels as well as manually adding the labels to the dictionary that holds all the MR property values.

# Look-up tables
# Usage
In this preliminary version of the repository, the code must be ran under the [cli](https://github.com/shimming-toolbox/tissue-to-MRproperty/tree/main/cli) folder.
```
git clone https://github.com/shimming-toolbox/tissue-to-MRproperty.git
cd cli
```
Once in the folder you can open a terminal and use the script to create a new MR-property volume. </br>

**Arguments**
- -t, type : 'Choose a MR property to convert to'
- -s, segmentattion tool : 'Specify the segmentation tool used'

Example:
```
python tissue_to_mr.py converter "final_total_seg.nii.gz" -s TotalSeg -t sus
```

**Output** The new volume will be saved as Nifti inside the *output* folder.

*Note*: for this version of the code the Nifti file must be in the cli directory. Only **t2s**, **pd** and **sus** are supported MR properties. Segmentation tool is not used yet, depending on the tool used for segmentation the code will use different lookup tables.

*T1, T2 and more segmentation tools coming soon!*

# Look-up table
Here we document the respective look-up tables used for assigning MR property values to labels. This are acquired from literature publications, reference to the literature used for creating the look-up table are inside the code for the [label](functions/label.py) class.


| Label | T1 [ms] | T2 [ms] | T2* [ms] | PD | Susceptibility [ppm] |
|---------------|------|------|-------|------| ----------------------------|
| air | 0 | 0 | 0.01 | 0.01 | 0.35 |
Expand Down Expand Up @@ -49,10 +73,6 @@ Here we document the respective look-up tables used for assigning MR property va

T1 and T2 values are still not completely implemented. </br>

# Output

The output volumes will be nifti files in which every pixel will have a MR property value. For now only T2star, PD and susceptibility volumes can be created. T1 and Net Magnetization (M0) are currently being implemented.

# References

[1] Wasserthal, J., Breit, H.-C., Meyer, M.T., Pradella, M., Hinck, D., Sauter, A.W., Heye, T., Boll, D., Cyriac, J., Yang, S., Bach, M., Segeroth, M., 2023. TotalSegmentator: Robust Segmentation of 104 Anatomic Structures in CT Images. Radiology: Artificial Intelligence. https://doi.org/10.1148/ryai.230024 </br>

0 comments on commit 6c2cfb8

Please sign in to comment.