API Documentation

Main MNE-RSA functions

rsa_epochs(epochs, rdm_model[, noise_cov, ...])	Perform RSA in a searchlight pattern on epochs.
rsa_evokeds(evokeds, rdm_model[, noise_cov, ...])	Perform RSA in a searchlight pattern on evokeds.
rsa_stcs(stcs, rdm_model[, src, ...])	Perform RSA in a searchlight pattern on MNE-Python source estimates.
rsa_nifti(image, rdm_model[, ...])	Perform RSA in a searchlight pattern on Nibabel Nifti-like images.

Constructing RDMs

compute_rdm(data[, metric])	Compute a dissimilarity matrix (RDM).
compute_rdm_cv(folds[, metric])	Compute a dissimilarity matrix (RDM) using cross-validation.
rdm_epochs(epochs[, noise_cov, ...])	Generate RDMs in a searchlight pattern on epochs.
rdm_stcs(stcs[, src, spatial_radius, ...])	Generate RDMs in a searchlight pattern on MNE-Python source estimates.
rdm_nifti(image[, spatial_radius, ...])	Generate RDMs in a searchlight pattern on Nibabel Nifty-like images.

rdm_array(X[, patches, dist_metric, ...])

Generate RDMs from an array of data, possibly in a searchlight pattern.

Performing RSA

rsa(rdm_data, rdm_model[, metric, ...])	Perform RSA between data and model RDMs.
rsa_array(X, rdm_model[, patches, ...])	Perform RSA on an array of data, possibly in a searchlight pattern.
rsa_gen(rdm_data_gen, rdm_model[, metric, ...])	Generate RSA values between data and model RDMs.

Making searchlight patches

searchlight(shape[, dist, spatial_radius, ...])

Generate indices for searchlight patches.

Visualization

plot_rdms(rdms[, names, items, n_rows, ...])	Plot one or more RDMs.
plot_rdms_topo(rdms, info[, time, layout, ...])	Plot RDMs on 2D sensor topography.
plot_roi_map(values, rois, subject, subjects_dir)	Plot ROI values on a FreeSurfer brain.

Utility functions

create_folds(X[, y, n_folds])	Group individual items into folds suitable for cross-validation.
squareform(X[, force, checks])	Convert a vector-form distance vector to a square-form distance matrix, and vice-versa.