Coffeine is designed for building biomedical prediction models from M/EEG signals. The library provides a high-level interface facilitating the use of M/EEG covariance matrix as representation of the signal. The methods implemented here make use of tools and concepts implemented in PyRiemann. The API is fully compatible with scikit-learn and naturally integrates with MNE.
import mne
from coffeine import compute_coffeine, make_filter_bank_regressor
# load EEG data from linguistic experiment
eeg_fname = mne.datasets.kiloword.data_path() / "kword_metadata-epo.fif"
epochs = mne.read_epochs(eeg_fname)[:50] # 50 samples
# compute covariances in different frequency bands
X_df, feature_info = compute_coffeine( # (defined by IPEG consortium)
epochs, frequencies=('ipeg', ('delta', 'theta', 'alpha1'))
) # ... and put results in a pandas DataFrame.
y = epochs.metadata["WordFrequency"] # regression target
# compose a pipeline
model = make_filter_bank_regressor(method='riemann', names=X_df.columns)
model.fit(X_df, y)
import matplotlib.pyplot as plt
fig, axes = plt.subplots(1, 3, figsize=(8, 3))
for ii, name in enumerate(('delta', 'theta', 'alpha1')):
axes[ii].matshow(X_df[name].mean(), cmap='PuOr')
axes[ii].set_title(name)
For this purpose, coffeine uses DataFrames to handle multiple covariance matrices alongside scalar features. Vectorization and model composition functions are provided that handle composition of valid scikit-learn modeling pipelines from covariances alongside other types of features as inputs.
The filter-bank pipelines (e.g. across multiple frequency bands or conditions) can the thought of as follows:
M/EEG covariance-based modeling pipeline from Sabbagh et al. 2020, NeuroImage
After preprocessing, covariance matrices can be projected to a subspace by spatial filtering to mitigate field spread and deal with rank deficient signals. Subsequently, vectorization is performed to extract column features from the variance, covariance or both. Every path combnining different lines in the graph describes one particular prediction model. The Riemannian embedding is special in mitigating field spread and providing vectorization in 1 step. It can be combined with dimensionality reduction in the projection step to deal with rank deficiency. Finally, a statistical learning algorithm can be applied.
The representation, projection and vectorization steps are separately done for each frequency band (or condition).
You can clone this library, and then do:
$ pip install -e .
Everything worked if the following command do not return any error:
$ python -c 'import coffeine'
When publishing research using coffeine, please cite our core paper.
@article{sabbagh2020predictive,
title={Predictive regression modeling with MEG/EEG: from source power to signals and cognitive states},
author={Sabbagh, David and Ablin, Pierre and Varoquaux, Ga{\"e}l and Gramfort, Alexandre and Engemann, Denis A},
journal={NeuroImage},
volume={222},
pages={116893},
year={2020},
publisher={Elsevier}
}
Please cite additional references highlighted in the documentation of specific functions and tutorials when using these functions and examples.
Please also cite the upstream software this package is building on, in particular PyRiemann.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent