Skip to content

Commit 04f1cd1

Browse files
committed
docs: update README with segment-dti-lesions and compute-brain-lesions-volumes commands
1 parent 91dd0ca commit 04f1cd1

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,36 @@ In this table, the column names are:
136136
- `atlas_label`: Label of the region of interest within the atlas.
137137
- `statistic_strategy`: The statistics used to compute the value (e.g., mean, standard deviation, etc.).
138138

139+
### Segment DTI Lesions
140+
141+
The `segment-dti-lesions` command identifies and segments abnormal voxels in DTI data based on previously computed
142+
normative values.
143+
144+
```bash
145+
python oxytcmricli.py segment-dti-lesions --settings <settings_filepath>
146+
[--dti-metrics <dti_metrics>]
147+
[--mri-exam-id <mri_exam_id>]
148+
```
149+
- `--settings` or `-s`: Path to the settings file (required).
150+
- `--dti-metrics` or `-dti`: Comma-separated list of DTI metrics to segment (e.g., 'FA,MD'). If not provided, all metrics will be used.
151+
- `--mri-exam-id` or `-mri`: MRI exam ID to segment lesions. If not provided, all exams will be processed.
152+
The resulting Nifti files are stored in the folder specified in the settings file.
153+
154+
### Compute Brain Lesions Volumes
155+
156+
The compute-brain-lesions-volumes command calculates the volumes of brain lesions based on DTI metrics and specified
157+
regions of interest.
158+
159+
```bash
160+
python oxytcmricli.py compute-brain-lesions-volumes --settings <settings_filepath>
161+
[--dti-metrics <dti_metrics>]
162+
[--mri-exam-id <mri_exam_id>]
163+
[--regions-of-interest <regions_of_interest>]
164+
```
165+
- `--settings` or `-s`: Path to the settings file (required).
166+
- `--dti-metrics` or `-dti`: Comma-separated list of DTI metrics to compute volumes for (e.g., 'FA,MD'). If not provided, all metrics will be used.
167+
- `--mri-exam-id` or `-mri`: MRI exam ID to compute volumes for. If not provided, all exams will be processed.
168+
- `--regions-of-interest` or `-roi`: (work in progress) Comma-separated list of regions of interest to compute volumes for (e.g., 'thalami,corpus-callosum'). If not provided, all regions will be used.
139169

140170
## Documentation
141171

0 commit comments

Comments
 (0)