SaveOutput¶

Bases: BaseClass

Class for saving the output data.

MNE-functions used: mne.io.Raw.save, mne.io.Raw.to_data_frame, mne.Epochs.to_data_frame

Parameters:

Name	Type	Description	Default
`raw`	`Raw \| Epochs`	Input data to be saved.	required
`export_formats`	`fif \| csv \| None`	Format to save the data. If None, the data is not saved.	required
`output_file`	`str \| None`	Path to the output file. If None, the data is not saved.	required
`overwrite`	`bool`	Whether to overwrite existing files with the same name.	`True`
`silent`	`bool`	If True, suppresses output messages.	`False`

Attributes:

Name	Type	Description
`processed`	`Raw \| Epochs`	Output data (same as input data; this class is for saving, not processing).

Example settings for config file¶

Example settings in correct format for the config file.

SaveOutput:
  _biopap_module: <class 'biopap.modules.save_output.SaveOutput'>
  export_formats: 
  - 'fif'
  - 'csv'
  output_file: './output/preprocessed_data-epo'
  overwrite: true