pyavs.apply_maxwell_filter¶
- pyavs.apply_maxwell_filter(raw: mne.io.Raw, crosstalk_file: str | None = None, fine_cal_file: str | None = None, find_bad_channels: bool = True, coord_frame: str = 'head', int_order: int = 8, ext_order: int = 3, origin: str | tuple = 'auto', regularize: str = 'in', ignore_ref: bool = True, bad_condition: str = 'error', head_pos: str | None = None, st_duration: float | None = None, st_correlation: float = 0.98, mag_scale: float = 100.0, skip_by_annotation: str | list = 'edge', extended_proj: list = [], verbose: bool = True) mne.io.Raw[source]¶
Apply Maxwell filtering (tSSS) to MEG data.
- Parameters:
raw (mne.io.Raw) – Raw MEG data
crosstalk_file (str, optional) – Path to crosstalk compensation file
fine_cal_file (str, optional) – Path to fine calibration file
find_bad_channels (bool, optional) – Whether to automatically detect bad channels (default: True)
coord_frame (str, optional) – Coordinate frame for Maxwell filtering (default: ‘head’)
int_order (int, optional) – Internal multipole order (default: 8)
ext_order (int, optional) – External multipole order (default: 3)
origin (str or tuple, optional) – Head origin (default: ‘auto’)
regularize (str, optional) – Regularization method (default: ‘in’)
ignore_ref (bool, optional) – Ignore reference channels (default: True)
bad_condition (str, optional) – How to handle bad condition (default: ‘error’)
head_pos (str, optional) – Path to head position file
st_duration (float, optional) – Signal space separation duration (default: None)
st_correlation (float, optional) – Correlation threshold for tSSS (default: 0.98)
mag_scale (float, optional) – Magnetometer scaling factor (default: 100.0)
skip_by_annotation (str or list, optional) – Annotations to skip (default: ‘edge’)
extended_proj (list, optional) – Extended projections (default: [])
verbose (bool, optional) – Whether to print progress information (default: True)
- Returns:
Maxwell filtered raw data
- Return type: