meegpype.interfaces.mne.preprocessing.filter_chpi module🔗

class meegpype.interfaces.mne.preprocessing.filter_chpi.FilterChpi(from_file=None, resource_monitor=None, ignore_exception=False, **inputs)🔗

Bases: BaseInterface

Mandatory Inputs:

raw (a pathlike object or string representing an existing file or a pathlike object or string representing an existing directory) – The input raw file.

Optional Inputs:

  • allow_line_only (a boolean) – If True, allow filtering line noise only. The default is False, which only allows the function to run when cHPI information is present.

  • ext_order (an integer) – The external order for SSS-like interfence suppression. The SSS bases are used as projection vectors during fitting.

  • include_line (a boolean) – If True, also filter line noise.

  • overwrite (a boolean) – Overwrite existing files.

  • t_step (a float) – Time step to use for estimation, default is 0.01 (10 ms).

  • t_window (a float) – Time window to use to estimate the amplitudes, default is 0.2 (200 ms).

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

Outputs:

  • raw (a pathlike object or string representing an existing file) – The raw file.

  • splits (a list of items which are a pathlike object or string representing an existing file)