Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the user guide for the big picture.

nilearn.interfaces.bids.parse_bids_filename

nilearn.interfaces.bids.parse_bids_filename(img_path, legacy=True)

Return dictionary with parsed information from file path.

Parameters:

img_pathstr

Path to file from which to parse information.

legacybool, default=True

Whether to return a dictionary that uses BIDS terms (False) or the legacy content for the output (True). False will become the default in version >= 0.13.2.

Added in version 0.11.2dev.

Returns:

referencedict

Returns a dictionary with all key-value pairs in the file name parsed and other useful fields.

The dictionary will contain 'file_path', 'file_basename'.

If legacy is set to True, the dictionary will also contain ‘file_tag’, ‘file_type’ and ‘file_fields’. The ‘file_tag’ field refers to the last part of the file under the BIDS convention that is of the form *_tag.type. Contrary to the rest of the file name it is not a key-value pair. This notion should be revised in the case we are handling derivatives since so far the convention will keep the tag prepended to any fields added in the case of preprocessed files that also end with another tag. This parser will consider any tag in the middle of the file name as a key with no value and will be included in the ‘file_fields’ key.

If legacy is set to False, the dictionary will instead contain 'extension', 'suffix' and 'entities'. (See the documentation on typical bids filename for more information).