rsatoolbox.io.bids module

Mapping data files in a Brain Imaging Data Structure (BIDS) layout.

class rsatoolbox.io.bids.BidsFile(relpath: str, layout: BidsLayout)

Bases: object

derivative: str | None

desc: str | None

ext: str

property fpath: str

get_meta() → Dict[str, Any]

get_table_sibling(desc: str, suffix: str) → BidsTableFile

modality: str | None

run: str | None

ses: str | None

space: str | None

sub: str | None

suffix: str

task: str | None

class rsatoolbox.io.bids.BidsJsonFile(relpath: str, layout: BidsLayout)

Bases: BidsFile

get_data() → Dict

class rsatoolbox.io.bids.BidsLayout(path: str, nibabel: Any | None = None)

Bases: object

abs_path(file: BidsFile) → str

find_events_for(base: BidsFile) → BidsTableFile

find_meta_for(base: BidsFile) → BidsJsonFile

find_mri_derivative_files(derivative: str, desc: str, tasks: List[str] | None = None) → List[BidsMriFile]

find_mri_sibling_of(base: BidsMriFile, desc: str, suffix: str) → BidsMriFile

find_table_key_for(base: BidsFile) → BidsTableFile

find_table_sibling_of(base: BidsFile, desc: str, suffix: str) → BidsTableFile

class rsatoolbox.io.bids.BidsMriFile(relpath: str, layout: BidsLayout, nibabel)

Bases: BidsFile

get_data() → NDArray

get_events() → DataFrame

get_key() → BidsTableFile

get_mri_sibling(desc: str, suffix: str) → BidsMriFile

class rsatoolbox.io.bids.BidsTableFile(relpath: str, layout: BidsLayout)

Bases: BidsFile

get_frame() → DataFrame