Javier Pérez de Frutos commited on
Commit
a84d9c8
·
unverified ·
1 Parent(s): a03ac95

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +20 -1
README.md CHANGED
@@ -24,9 +24,28 @@ source venv/bin/activate
24
 
25
  2. Install requirements:
26
  ```
27
- pip install -r requirements.txt
28
  ```
29
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
30
  ## 🏋️‍♂️ Training
31
 
32
  Use the "MultiTrain" scripts to launch the trainings, providing the neccesary parameters. Those in the COMET folder accepts a .ini configuration file (see COMET/train_config_files for example configurations).
 
24
 
25
  2. Install requirements:
26
  ```
27
+ pip install /path/to/clone/.
28
  ```
29
 
30
+ ## 🤖 How to use
31
+ Use the following CLI command to register images
32
+ ```
33
+ ddmr --fixed path/to/fixed_image.nii.gz --moving path/to/moving_image.nii.gz --outputdir path/to/output/dir -a <anatomy> --model <model> --gpu <gpu-number> --original-resolution
34
+ ```
35
+ where:
36
+ * anatomy: is the type of anatomy you want to register: B (brain) or L (liver)
37
+ * model: is the model you want to use:
38
+ + BL-N (baseline with NCC)
39
+ + BL-NS (baseline with NCC and SSIM)
40
+ + SG-ND (segmentation guided with NCC and DSC)
41
+ + SG-NSD (segmentation guided with NCC, SSIM, and DSC)
42
+ + UW-NSD (uncertainty weighted with NCC, SSIM, and DSC)
43
+ + UW-NSDH (uncertainty weighted with NCC, SSIM, DSC, and HD).
44
+ * gpu: is the GPU number you want to the model to run on, if you have multiple and want to use only one GPU
45
+ * original-resolution: (flag) whether to upsample the registered image to the fixed image resolution (disabled if the flag is not present)
46
+
47
+ Use ```ddmr --help``` to see additional options like using precomputed segmentations to crop the images to the desired ROI, or debugging.
48
+
49
  ## 🏋️‍♂️ Training
50
 
51
  Use the "MultiTrain" scripts to launch the trainings, providing the neccesary parameters. Those in the COMET folder accepts a .ini configuration file (see COMET/train_config_files for example configurations).