pybemobil.preproc.get_derivative_paths#

pybemobil.preproc.get_derivative_paths(fname_out)[source]#

Return the paths of all derivatives EEGPreprocessor writes.

File names follow BIDS: the entities in the file name of fname_out (sub-, ses-, task-, run-, …) are kept, its suffix (e.g. _eeg) and any desc- entity are dropped, and each output gets a desc- label or its own suffix. The extension of fname_out (.fif or .fif.gz, default .fif) is used for the FIF files. For <dir>/sub-01_task-walk_eeg.fif.gz:

  • "clean": sub-01_task-walk_desc-clean_eeg.fif.gz

  • "pre_ica": sub-01_task-walk_desc-preica_eeg.fif.gz

  • "ica": sub-01_task-walk_ica.fif.gz

  • "iclabels": sub-01_task-walk_iclabels.json

  • "bad_channels": sub-01_task-walk_badchannels.json

  • "dipoles": sub-01_task-walk_dipoles/ (one file per IC)

  • "trans": sub-01_task-walk_trans.fif

  • "report": sub-01_task-walk_report.html

  • "figures": sub-01_task-walk_figures/ (report images, e.g. the joint ERP plots)

All paths are in the folder of fname_out. The untouched input is not a derivative; it goes to the raw part of the BIDS dataset (see save_bids_raw in EEGPreprocessor).

Parameters:
fname_outstr | Path

The fname_out passed to EEGPreprocessor.run_raw().

Returns:
pathsdict of str to Path

The paths, keyed as listed above.