io_readbids
Module reading bids specification for an input folder.
Keywords : Bids, Input, Structure
Inputs
Section titled “Inputs”Input 1
Section titled “Input 1”Format : path(bids_folder)
| Type | Description | Mandatory | Pattern | |
|---|---|---|---|---|
| bids_folder | directory | Folder containing bids file | True | * |
Input 2
Section titled “Input 2”Format : path(fs_folder)
| Type | Description | Mandatory | Pattern | |
|---|---|---|---|---|
| fs_folder | directory | Folder containing fs file | True | * |
Input 3
Section titled “Input 3”Format : path(bids_ignore)
| Type | Description | Mandatory | Pattern | |
|---|---|---|---|---|
| bids_ignore | file | bids_ignore file | True | *.{bids_ignore} |
Outputs
Section titled “Outputs”bidsstructure
Section titled “bidsstructure”Format : path(bids_struct.json)
| Type | Description | Mandatory | Pattern | |
|---|---|---|---|---|
| bids_struct.json | file | json file containing tractoflow bids structure | True | bids_struct.json |
versions
Section titled “versions”Format : path(versions.yml)
| Type | Description | Mandatory | Pattern | |
|---|---|---|---|---|
| versions.yml | file | File containing software versions | True | versions.yml |
Arguments (see process.ext)
Section titled “Arguments (see process.ext)”| Type | Description | Default | Choices | |
|---|---|---|---|---|
| readout | float | Readout time to add in metadata. | 0.062 | |
| clean_bids | boolean | If set to true, will remove participants with missing files from the final BIDS layout. | False | |
| relative_paths | boolean | If set to true, will convert absolute paths to relative paths in the output BIDS structure JSON file. | False |
| Description | DOI | |
|---|---|---|
| scilpy | The Sherbrooke Connectivity Imaging Lab (SCIL) Python dMRI processing toolbox. |
Authors
Section titled “Authors”Last updated : 2025-12-22