mne.chpi.filter_chpi¶
-
mne.chpi.
filter_chpi
(raw, include_line=True, t_step=0.01, t_window=0.2, verbose=None)[source]¶ Remove cHPI and line noise from data.
Note
This function will only work properly if cHPI was on during the recording.
- Parameters
- rawinstance of
Raw
Raw data with cHPI information. Must be preloaded. Operates in-place.
- include_linebool
If True, also filter line noise.
- t_step
float
Time step to use for estimation, default is 0.01 (10 ms).
- t_window
float
Time window to use to estimate the amplitudes, default is 0.2 (200 ms).
- verbosebool,
str
,int
, orNone
If not None, override default verbose level (see
mne.verbose()
and Logging documentation for more).
- rawinstance of
- Returns
- rawinstance of
Raw
The raw data.
- rawinstance of
Notes
cHPI signals are in general not stationary, because head movements act like amplitude modulators on cHPI signals. Thus it is recommended to to use this procedure, which uses an iterative fitting method, to remove cHPI signals, as opposed to notch filtering.
New in version 0.12.