This documentation is for development version 0.18.dev0.

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=True, filter_length='10s', n_jobs=1, ch_name=None, reject={'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='fir', iir_params=None, copy=True, return_drop_log=False, verbose=None)[source]

Compute SSP/PCA projections for ECG artifacts.

Note

raw data will be loaded if it is not already.

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 for the data channels in Hz.

h_freq : float | None

Filter high cut-off frequency for the data channels in Hz.

average : bool

Compute SSP after averaging. Default is True.

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 to the ECG channel for event detection.

ecg_h_freq : float

High pass frequency applied to the ECG channel for event detection.

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 ‘fir’).

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.

return_drop_log : bool

If True, return the drop log.

New in version 0.15.

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.

drop_log : list

The drop log, if requested.

Notes

Filtering is applied to the ECG channel while finding events using ecg_l_freq and ecg_h_freq, and then to the raw instance using l_freq and h_freq before creation of the epochs used to create the projectors.