Skip to content

Commit

Permalink
fixed the data structure part of the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Reza committed Mar 20, 2024
1 parent 9e233dd commit 92fcf3a
Showing 1 changed file with 25 additions and 23 deletions.
48 changes: 25 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,26 +82,6 @@ Enter input image directory: /path/to/my_mri_data
```
The classified directory (`classified_dir`) is the input directory to PyALFE and should be organized by accessions (or session ids). Inside the directory for each accession there should be a directory for each available modality.
Here is an example that follow ALFE default structure:

```
my_mri_data
│───anat
│ │───sub-123_T1w.nii.gz
│ │───sub-123_T2w.nii.gz
│ └───sub-123_FLAIR.nii.gz
│───dwi
│ │───sub-123_dwi.nii.gz
│ └───sub-123_md.nii.gz
│───swi
│ └───sub-123_swi.nii.gz
└───perf
└───sub-123_cbf.nii.gz
```
To use this directory the user should provide `path/to/my_mri_data` as the classified directory. This config value can be overwritten when calling `pyalfe run` via `-cd` or `--classified-dir` option.

pyALFE also supports BIDS directories. Here is an example of input dir organized in BIDS format:
```
my_mri_data
Expand All @@ -115,9 +95,10 @@ my_mri_data
│ │ └── FLAIR.nii.gz
│ │───ADC
│ │ └── ADC.nii.gz
│ └───T2
│ └── T2.nii.gz
│ │───T2
│ │ └── T2.nii.gz
│ └───CBF
│ └── CBF.nii.gz
└───12356
. │
. │───T1
Expand All @@ -131,6 +112,27 @@ my_mri_data
└───T2
└── T2.nii.gz
```
To use this directory the user should provide `path/to/my_mri_data` as the classified directory. This config value can be overwritten when calling `pyalfe run` via `-cd` or `--classified-dir` option.

pyALFE also supports BIDS directories. Here is an example of input dir organized in BIDS format:

```
my_mri_data
│───anat
│ │───sub-123_T1w.nii.gz
│ │───sub-123_T2w.nii.gz
│ └───sub-123_FLAIR.nii.gz
│───dwi
│ │───sub-123_dwi.nii.gz
│ └───sub-123_md.nii.gz
│───swi
│ └───sub-123_swi.nii.gz
└───perf
└───sub-123_cbf.nii.gz
```

#### Processed directory
```bash
Enter input image directory: /path/to/processed_data_dir
Expand Down

0 comments on commit 92fcf3a

Please sign in to comment.