bids_commands.py

get_bids_filename

get_bids_filename(*args, **kwargs)

Create a BIDS-compliant filename from the specified options.

get_scan_id(subject=SUBJECT, session=SESSION, task=TASK, acquisition=ACQUISITION, run=RUN, process=PROCESS, resolution=RESOLUTION, space=SPACE, description=DESCRIPTION, suffix=SUFFIX, extension=EXTENSION)

Parameters:

• subject (str) – Optional subject identifier

• session (str) – Optional session identifier

• task (str) – Optional BIDS description (task-ABC)

• acquisition (str) – BIDS description (acq-ABC)

• run (str) – Optional BIDS description (run-ABC)

• process (str) – Optional BIDS description (proc-ABC)

• resolution (str) – Optional BIDS description (res-ABC)

• space (str) – Optional BIDS description (space-ABC)

• description (str) – Optional BIDS description (desc-ABC)

• suffix (str) – Optional BIDS suffix

• extension (str) – Optional filename extension (do not begin with ‘.’)

Raises:

Error – Any error occurs.

Returns:

BIDS compliant filename string

Return type:

str

get_bids_labels

get_bids_labels(IN_FILE)

Get BIDS-compliant labels from specified filename

get_bids_labels(IN_FILE)

Parameters:

IN_FILE (str) – Required fullpath or filename

Raises:

Error – Any error occurs.

Returns:

Dictionary containing extracted BIDS labels

Return type:

dict