Skip to content

Commit 7261329

Browse files
updated help for bids processing
1 parent a65d20d commit 7261329

File tree

3 files changed

+552
-254
lines changed

3 files changed

+552
-254
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ MicaFlow is a comprehensive neuroimaging pipeline designed for processing struct
1212
- **Image Registration**: Multi-modal coregistration and spatial normalization to standard spaces
1313
- **Texture Features**: Advanced texture feature generation
1414
- **Quality Control**: Built-in QC metrics and visualization
15+
- **Batch Processing**: Automated BIDS directory scanning and processing
1516
- **Brain-Extracted Outputs**: Optional dedicated directory for all skull-stripped images
1617
- **Temporary File Management**: Option to preserve intermediate files for debugging
1718
- **Modular Design**: Components can be used independently or as a complete pipeline
@@ -64,6 +65,28 @@ micaflow pipeline --subject sub-001 --session ses-01 \
6465
--out-dir /output/path --cores 4 --cpu
6566
```
6667

68+
### Batch Processing (BIDS)
69+
70+
To process an entire BIDS dataset automatically using the batch command:
71+
72+
```bash
73+
micaflow bids --bids-dir /path/to/bids_root --output-dir /path/to/derivatives \
74+
--cores 4 --gpu
75+
```
76+
77+
This command will:
78+
1. Scan the BIDS directory for valid subjects and sessions.
79+
2. Automatically identify T1w, FLAIR (optional), and DWI (optional) files based on suffixes.
80+
3. Run the pipeline sequentially for each session found.
81+
4. Generate a `micaflow_runs_summary.json` in the output directory tracking execution status.
82+
83+
**key arguments:**
84+
- `--bids-dir`: Root path to the BIDS dataset.
85+
- `--output-dir`: Path where derivatives will be saved.
86+
- `--participant-label`: (Optional) Space-separated list of subject IDs to process (e.g., `001 002`).
87+
- `--session-label`: (Optional) Space-separated list of session IDs to process.
88+
- `--t1w-suffix`, `--dwi-suffix`, etc.: Customize matching patterns for input files.
89+
6790
### Using Individual Modules
6891

6992
Each module can be used independently:

0 commit comments

Comments
 (0)