Skip to content

Commit 12f0d9c

Browse files
author
Clément POIRET
committed
Updated README
1 parent daf3ee9 commit 12f0d9c

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.rst

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Welcome to ROILoc
55
ROILoc is a registration-based ROI locator, based on the MNI152 09c Sym template, and the CerebrA Atlas. It'll center and crop T1 or T2 MRIs around a given ROI.
66

77
.. image:: https://raw.githubusercontent.com/clementpoiret/ROILoc/main/example.png
8-
:width: 400
8+
:width: 800
99
:alt: Example: using ROILoc for Hippocampus
1010

1111
If the results aren't correct, please consider performing BET/Skull Stripping on your subject's MRI beforehand, then pass ``-b True`` afterward.
@@ -20,7 +20,10 @@ It requires the following packages:
2020
- Pandas,
2121
- Rich.
2222

23-
usage: roiloc [-h] -p PATH -i INPUTPATTERN [-r ROI] -c CONTRAST [-b BET] [-t TRANSFORM] [-m MARGIN [MARGIN ...]] [--mask MASK]
23+
usage: roiloc [-h] -p PATH -i INPUTPATTERN [-r ROI [ROI ...]] -c CONTRAST
24+
[-b BET] [-t TRANSFORM] [-m MARGIN [MARGIN ...]] [--mask MASK]
25+
[--extracrops EXTRACROPS [EXTRACROPS ...]]
26+
[--savesteps SAVESTEPS]
2427

2528
arguments::
2629

@@ -29,7 +32,8 @@ arguments::
2932
-i INPUTPATTERN, --inputpattern INPUTPATTERN
3033
<Required> Pattern to find input images in input path
3134
(e.g.: `**/*t1*.nii.gz`).
32-
-r ROI, --roi ROI ROI included in CerebrA. See
35+
-r ROI [ROI ...], --roi ROI [ROI ...]
36+
ROI included in CerebrA. See
3337
`roiloc/MNI/cerebra/CerebrA_LabelDetails.csv` for more
3438
details. Default: 'Hippocampus'.
3539
-c CONTRAST, --contrast CONTRAST
@@ -46,9 +50,15 @@ arguments::
4650
has to be a list of 3 integers, to control the margin
4751
in the three axis. Default: [8,8,2]
4852
--mask MASK Pattern for brain tissue mask to improve registration
49-
(e.g.: `**/sub_*bet_mask.nii.gz`). If providing a BET
53+
(e.g.: `sub_*bet_mask.nii.gz`). If providing a BET
5054
mask, please also pass `-b True` to use a BET MNI
5155
template.
56+
--extracrops EXTRACROPS [EXTRACROPS ...]
57+
Pattern for other files to crop (e.g. manual
58+
segmentation: '*manual_segmentation_left*.nii.gz').
59+
--savesteps SAVESTEPS
60+
Save intermediate files (e.g. registered atlas).
61+
Default: False.
5262

5363

5464
Installation

0 commit comments

Comments
 (0)