Skip to content

Commit

Permalink
updated readme and main
Browse files Browse the repository at this point in the history
  • Loading branch information
Reza Eghbali committed May 22, 2024
1 parent 7155f53 commit 6d691f4
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 15 deletions.
52 changes: 38 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,25 +112,40 @@ my_mri_data
└───T2
└── T2.nii.gz
```
To use this directory the user should provide `path/to/my_mri_data` as the input directory. This config value can be overwritten when calling `pyalfe run` via `-cd` or `--input-dir` option.
To use this directory the user should provide `path/to/my_mri_data` as the input directory. This config value can be overwritten when calling `pyalfe run` via `-id` or `--input-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_ce-gadolinium_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
│───sub-01
│ │───anat
│ │ │───sub-01_T1w.nii.gz
│ │ │───sub-01_ce-gadolinium_T1w.nii.gz
│ │ │───sub-01_T2w.nii.gz
│ │ └───sub-01_FLAIR.nii.gz
│ │───dwi
│ │ │───sub-01_dwi.nii.gz
│ │ └───sub-01_md.nii.gz
│ │───swi
│ │ └───sub-01_swi.nii.gz
│ └───perf
│ └───sub-01_cbf.nii.gz
└───sub-02
. │───anat
. │ │───sub-02_T1w.nii.gz
. │ │───sub-02_ce-gadolinium_T1w.nii.gz
│ │───sub-02_T2w.nii.gz
│ └───sub-02_FLAIR.nii.gz
│───dwi
│ │───sub-02_dwi.nii.gz
│ └───sub-02_md.nii.gz
│───swi
│ └───sub-02_swi.nii.gz
└───perf
└───sub-02_cbf.nii.gz
```

Expand All @@ -140,7 +155,8 @@ Enter output image directory: /path/to/output_dir
```
The output image directory (`output_dir`) is where pyALFE writes all its output to.
It can be any valid path in filesystem that user have write access to.
This config value can be overwritten when calling `pyalfe run` via `-pd` or `--output-dir` option.
This config value can be overwritten when calling `pyalfe run` via `-od` or `--output-dir` option.


#### Modalities
```bash
Expand Down Expand Up @@ -187,6 +203,14 @@ In other to use greedy, you have to download it using the [download command](#do
install pyalfe with ants support ``pip install pyalfe[ants]``.
This config value can be overwritten when calling `pyalfe run` via `-ir` or `--image-registration` option.

#### Dierctory Data Structure
```bash
data directory structure (press enter for default) (alfe, bids) [alfe]:
```

The directory structure that pyALFE expects in the input directory and will follow when creating the output. See [Inupt directory](#### Input directory) for information on ALFE and BIDS.
This config value can be overwritten when calling `payalfe run` via `-dds` or `--data-dir-structure` option.

### Running the pipeline
To run PyALFE for an accession

Expand Down
2 changes: 1 addition & 1 deletion pyalfe/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ def download(assets):
)
@click.option(
'-dds',
'--data_dir_structure',
'--data-dir-structure',
type=click.Choice(['alfe', 'bids'], case_sensitive=False),
)
def run(
Expand Down

0 comments on commit 6d691f4

Please sign in to comment.