mne.preprocessing.compute_proj_ecg¶

mne.preprocessing.compute_proj_ecg(raw, raw_event=None, tmin=-0.2, tmax=0.4, n_grad=2, n_mag=2, n_eeg=2, l_freq=1.0, h_freq=35.0, average=False, filter_length=‘10s’, n_jobs=1, ch_name=None, reject={‘eog’: 0.00025, ’grad’: 2e-10, ’mag’: 3e-12}, flat=None, bads=[], avg_ref=False, no_proj=False, event_id=999, ecg_l_freq=5, ecg_h_freq=35, tstart=0.0, qrs_threshold=’auto’, filter_method=’fft’, iir_params=None, copy=True, verbose=None)[source]¶

Compute SSP/PCA projections for ECG artifacts.

Note

raw data must be preloaded.

Parameters:

raw : mne.io.Raw Raw input file. raw_event : mne.io.Raw or None Raw file to use for event detection (if None, raw is used). tmin : float Time before event in seconds. tmax : float Time after event in seconds. n_grad : int Number of SSP vectors for gradiometers. n_mag : int Number of SSP vectors for magnetometers. n_eeg : int Number of SSP vectors for EEG. l_freq : float | None Filter low cut-off frequency in Hz. h_freq : float | None Filter high cut-off frequency in Hz. average : bool Compute SSP after averaging. filter_length : str | int | None Number of taps to use for filtering. n_jobs : int Number of jobs to run in parallel. ch_name : string (or None) Channel to use for ECG detection (Required if no ECG found). reject : dict | None Epoch rejection configuration (see Epochs). flat : dict | None Epoch flat configuration (see Epochs). bads : list List with (additional) bad channels. avg_ref : bool Add EEG average reference proj. no_proj : bool Exclude the SSP projectors currently in the fiff file. event_id : int ID to use for events. ecg_l_freq : float Low pass frequency applied for filtering ECG channel. ecg_h_freq : float High pass frequency applied for filtering ECG channel. tstart : float Start artifact detection after tstart seconds. qrs_threshold : float | str Between 0 and 1. qrs detection threshold. Can also be “auto” to automatically choose the threshold that generates a reasonable number of heartbeats (40-160 beats / min). filter_method : str Method for filtering (‘iir’ or ‘fft’). iir_params : dict | None Dictionary of parameters to use for IIR filtering. See mne.filter.construct_iir_filter for details. If iir_params is None and method=”iir”, 4th order Butterworth will be used. copy : bool If False, filtering raw data is done in place. Defaults to True. verbose : bool, str, int, or None If not None, override default verbose level (see mne.verbose() and Logging documentation for more).

Returns:

proj : list Computed SSP projectors. ecg_events : ndarray Detected ECG events.

Examples using mne.preprocessing.compute_proj_ecg¶

Artifact Correction with SSP