coffeine.power_features.get_frequency_bands

coffeine.power_features.get_frequency_bands(collection: str = 'ipeg', subset: list[str] | tuple[str] | None = None) → dict[str, tuple[float, float]]

Get pre-specified frequency bands based on the literature.

Next to sets of bands for defining filterbank models, the aggregate defined in the corresponding literature are provided.

Note

The HCP-MEG[1] frequency band was historically based on the documentation of the MEG analysis from the HCP-500 MEG2 release: https://wiki.humanconnectome.org/display/PublicData/MEG+Data+FAQ

As frequencies below 1.5Hz were omitted the work presented in [2,3] also defined a ‘low’ band (0.1 - 1.5Hz) while retaining the the other frequencies.

Note

The IPEG frequency bands were developed in [4].

Note

Additional band definitions can be added as per (pull) request.

Parameters:

collection{‘ipeg’, ‘ipeg_aggregated’, ‘hcp’, ‘hcp_aggregated’}

The set of frequency bands. Defaults to ‘hcp’.

subsetlist-like

A selection of valid keys to return a subset of frequency bands from a collection.

Returns:

frequency_bandsdict

The band definitions.

References

[1] Larson-Prior, L. J., R. Oostenveld, S. Della Penna, G. Michalareas,

F. Prior, A. Babajani-Feremi, J-M Schoffelen, et al. 2013. “Adding Dynamics to the Human Connectome Project with MEG.” NeuroImage 80 (October): 190–201.

[2] D. Sabbagh, P. Ablin, G. Varoquaux, A. Gramfort, and D.A. Engemann.

Predictive regression modeling with MEG/EEG: from source power to signals and cognitive states. NeuroImage, page 116893,2020. ISSN 1053-8119. https://doi.org/10.1016/j.neuroimage.2020.116893

[3] D. A. Engemann, O. Kozynets, D. Sabbagh, G. Lemaître, G. Varoquaux,

F. Liem, and A. Gramfort Combining magnetoencephalography with magnetic resonance imaging enhances learning of surrogate-biomarkers. eLife, 9:e54055, 2020 <https://elifesciences.org/articles/54055>

[4] Jobert, M., Wilson, F.J., Ruigt, G.S., Brunovsky, M., Prichep,

L.S., Drinkenburg, W.H. and IPEG Pharmaco-EEG Guideline Committee, 2012. Guidelines for the recording and evaluation of pharmaco-EEG data in man: the International Pharmaco-EEG Society (IPEG). Neuropsychobiology, 66(4), pp.201-220.