Skip to content

io_readbids

Module reading bids specification for an input folder.

Keywords : Bids, Input, Structure


Format : path(bids_folder)

TypeDescriptionMandatoryPattern
bids_folderdirectoryFolder containing bids fileTrue*

Format : path(fs_folder)

TypeDescriptionMandatoryPattern
fs_folderdirectoryFolder containing fs fileTrue*

Format : path(bids_ignore)

TypeDescriptionMandatoryPattern
bids_ignorefilebids_ignore fileTrue*.{bids_ignore}

Format : path(bids_struct.json)

TypeDescriptionMandatoryPattern
bids_struct.jsonfilejson file containing tractoflow bids structureTruebids_struct.json

Format : path(versions.yml)

TypeDescriptionMandatoryPattern
versions.ymlfileFile containing software versionsTrueversions.yml

TypeDescriptionDefaultChoices
readoutfloatReadout time to add in metadata.0.062
clean_bidsbooleanIf set to true, will remove participants with missing files from the final BIDS layout.False

DescriptionDOI
scilpyThe Sherbrooke Connectivity Imaging Lab (SCIL) Python dMRI processing toolbox.


Last updated : 2025-10-30