meegpype.interfaces.mne.report module🔗

class meegpype.interfaces.mne.report.MakeReport(from_file=None, resource_monitor=None, ignore_exception=False, **inputs)🔗

Bases: BaseInterface

Mandatory Inputs:

  • fname (a string or os.PathLike object) – Output file name. Use a name <dir>/<name>-trans.fif.

  • info (a string or os.PathLike object referring to an existing file) – Path to a file with measurement information.

  • subject (a string) – Subject name (required).

  • subjects_dir (a pathlike object or string representing an existing directory) – Subjects directory.

Optional Inputs:

  • forward (a string or os.PathLike object referring to an existing file) – The path to the file containing forward solution.

  • head_positions (a list of items which are a string or os.PathLike object) – List of head position figures.

  • overwrite (a boolean) – Overwrite existing files.

  • raws (a list of items which are a string or os.PathLike object) – List of raw files.

  • trans (a string or os.PathLike object referring to an existing file) – The path to the head<->MRI transform *-trans.fif file produced during coregistration.

  • verbose (a boolean) – Enable verbose mode (printing of log messages).

Outputs:

  • hdf5_report (a pathlike object or string representing an existing file) – The report file in hdf5 format.

  • html_report (a pathlike object or string representing an existing file) – The report file in HTML format.