API Documentation

Feature extraction

Functions

FeatureExtractor

Feature extraction from epoched EEG data.

extract_features

Extraction of temporal or spectral features from epoched EEG signals.

Univariate features

Functions

get_univariate_funcs(sfreq)

Mapping between aliases and univariate feature functions.

compute_mean(data)

Mean of the data (per channel).

compute_variance(data)

Variance of the data (per channel).

compute_std(data)

Standard deviation of the data.

compute_ptp_amp(data)

Peak-to-peak (PTP) amplitude of the data (per channel).

compute_skewness(data)

Skewness of the data (per channel).

compute_kurtosis(data)

Kurtosis of the data (per channel).

compute_rms(data)

Root-mean squared value of the data (per channel).

compute_quantile(data[, q])

Quantile of the data (per channel).

compute_hurst_exp(data)

Hurst exponent of the data (per channel).

compute_app_entropy(data[, emb, metric])

Approximate Entropy (AppEn, per channel).

compute_samp_entropy(data[, emb, metric])

Sample Entropy (SampEn, per channel).

compute_decorr_time(sfreq, data)

Decorrelation time (per channel).

compute_pow_freq_bands(sfreq, data[, …])

Power Spectrum (computed by frequency bands).

compute_hjorth_mobility_spect(sfreq, data[, …])

Hjorth mobility (per channel).

compute_hjorth_complexity_spect(sfreq, data)

Hjorth complexity (per channel).

compute_hjorth_mobility(data)

Hjorth mobility (per channel).

compute_hjorth_complexity(data)

Hjorth complexity (per channel).

compute_higuchi_fd(data[, kmax])

Higuchi Fractal Dimension (per channel).

compute_katz_fd(data)

Katz Fractal Dimension (per channel).

compute_zero_crossings(data[, threshold])

Number of zero-crossings (per channel).

compute_line_length(data)

Line length (per channel).

compute_spect_slope(sfreq, data[, fmin, …])

Linear regression of the the log-log frequency-curve (per channel).

compute_spect_entropy(sfreq, data[, …])

Spectral Entropy (per channel).

compute_svd_entropy(data[, tau, emb])

SVD entropy (per channel).

compute_svd_fisher_info(data[, tau, emb])

SVD Fisher Information (per channel).

compute_energy_freq_bands(sfreq, data[, …])

Band energy (per channel).

compute_spect_edge_freq(sfreq, data[, …])

Spectal Edge Frequency (per channel).

compute_wavelet_coef_energy(data[, wavelet_name])

Energy of Wavelet decomposition coefficients (per channel).

compute_teager_kaiser_energy(data[, …])

Compute the Teager-Kaiser energy.

Bivariate features

Functions

get_bivariate_funcs(sfreq)

Mapping between aliases and bivariate feature functions.

compute_max_cross_corr(sfreq, data[, …])

Maximum linear cross-correlation.

compute_phase_lock_val(data[, include_diag])

Phase Locking Value (PLV).

compute_nonlin_interdep(data[, tau, emb, …])

Measure of nonlinear interdependence.

compute_time_corr(data[, with_eigenvalues, …])

Correlation Coefficients (computed in the time domain).

compute_spect_corr(sfreq, data[, …])

Correlation Coefficients (computed from the power spectrum).

Fork me on GitHub