API Documentation

Cluster-based tests

Classes

Clusters(clusters, pvals, stat[, dimnames, …]) Container for results of cluster-based tests.

Functions

read_cluster(fname[, subjects_dir, src, info]) Read standard Clusters .hdf5 file and return Clusters object.

Statistics

Functions

compute_regression_t(data, preds[, return_p]) Compute regression t values for whole multidimensional data space.
format_pvalue(pvalue) Format p value according to APA rules.

visualization

Classes

Topo(values, info[, side]) High-level object that allows for convenient topographic plotting.

Current Source Density

Functions

current_source_density(inst, G, H[, …]) Compute current source density for given mne object instance.

Frequency space

Functions

compute_rest_psd(raw[, events, event_id, …]) Compute power spectral density (psd) for given time segments for all channels of given raw file.

Utilities

Functions

find_index(vec, vals) Find indices of values in vec that are closest to requested values vals.
find_range(vec, ranges) Find specified ranges in an ordered vector and return them as slices.
get_info(inst) Simple helper function that returns Info whatever mne object it gets.
get_dropped_epochs(epochs) Get indices of dropped epochs from epochs.drop_log.
silent_mne() Context manager that silences warnings from mne-python.
detect_overlap(segment, annot[, sfreq]) Detect what percentage of given segment is overlapping with annotations.
valid_windows(raw[, tmin, tmax, winlen, step]) Test which moving windows overlap with annotations.
create_fake_raw([n_channels, n_samples, sfreq]) Create fake raw signal for testing.
download_test_data() Download additional test data from dropbox.