andreped commited on
Commit
13ec1d9
·
unverified ·
2 Parent(s): 2e7d621 22cd156

Merge pull request #15 from andreped/docs

Browse files

Docs: Resized figures + added info on custom argument usage in CLI to README [no ci]

Files changed (1) hide show
  1. README.md +11 -2
README.md CHANGED
@@ -8,8 +8,11 @@ This is the official repository for the paper [_"Teacher-student approach for lu
8
 
9
  A pretrained model is made available in a command line tool and can be used as you please. However, the current model is not intended for clinical use. The model is the result of a proof-of-concept study. An improved model will be made available in the future, when more training data is made available.
10
 
11
- ![sample of masked output](https://github.com/VemundFredriksen/LungTumorMask/releases/download/0.0.1/sample_images.png "Sample output of two different tumors")
12
- ![sample of 3d render](https://github.com/VemundFredriksen/LungTumorMask/releases/download/0.0.1/sample_renders.png "3D render of two masked outputs")
 
 
 
13
 
14
  ## [Installation](https://github.com/VemundFredriksen/LungTumorMask#installation)
15
 
@@ -33,8 +36,14 @@ lungtumormask input_file output_file
33
 
34
  # Example
35
  lungtumormask patient_01.nii.gz mask_01.nii.gz
 
 
 
36
  ```
37
 
 
 
 
38
  ## [Citation](https://github.com/VemundFredriksen/LungTumorMask#citation)
39
  If you found this repository useful in your study, please, cite the following paper:
40
  ```
 
8
 
9
  A pretrained model is made available in a command line tool and can be used as you please. However, the current model is not intended for clinical use. The model is the result of a proof-of-concept study. An improved model will be made available in the future, when more training data is made available.
10
 
11
+ <img src="https://github.com/VemundFredriksen/LungTumorMask/releases/download/0.0.1/sample_images.png" width="70%">
12
+
13
+ <img src="https://github.com/VemundFredriksen/LungTumorMask/releases/download/0.0.1/sample_renders.png" width="70%">
14
+
15
+ &nbsp;
16
 
17
  ## [Installation](https://github.com/VemundFredriksen/LungTumorMask#installation)
18
 
 
36
 
37
  # Example
38
  lungtumormask patient_01.nii.gz mask_01.nii.gz
39
+
40
+ # Custom arguments
41
+ lungtumormask patient_01.nii.gz mask_01.nii.gz --lung-filter --threshold 0.3 --radius 3
42
  ```
43
 
44
+ In the last example, we filter tumor candidates outside the lungs, use a lower probability threshold to boost recall, and use a morphological smoothing step
45
+ to fill holes inside segmentations using a disk kernel of radius 3.
46
+
47
  ## [Citation](https://github.com/VemundFredriksen/LungTumorMask#citation)
48
  If you found this repository useful in your study, please, cite the following paper:
49
  ```