API Documentation¶

Forward models¶

`forward_to_tangential`(fwd[, center])	Convert a free orientation forward solution to a tangential one.
`restrict_forward_to_sensor_range`(fwd, dist)	Restrict forward operator to sources within given distance to a sensor.
`restrict_forward_to_vertices`(fwd, vertno_or_idx)	Restrict the forward model to the given vertices.
`restrict_src_to_vertices`(src, vertno_or_idx)	Restrict a source space to the given vertices.
`select_shared_vertices`(insts[, ref_src, …])	Select the vertices that are present in each of the given objects.
`select_vertices_in_sensor_range`(inst, dist)	Find vertices within given distance to a sensor.

Connectivity¶

Classes:

`LabelConnectivity`(data, pairs, labels[, …])	Estimation of all-to-all connectivity, parcellated into labels.
`VertexConnectivity`(data, pairs, vertices[, …])	Estimation of connectivity between vertices.

Functions:

`all_to_all_connectivity_pairs`(src_or_fwd[, …])	Obtain pairs of vertices to compute all-to-all connectivity for.
`dics_connectivity`(vertex_pairs, fwd, data_csd)	Compute spectral connectivity using a DICS beamformer.
`one_to_all_connectivity_pairs`(src_or_fwd, …)	Obtain pairs of vertices to compute one-to-all connectivity for.
`read_connectivity`(fname)	Read a Connectivity object from an HDF5 file.

Statistics¶

`cluster_threshold`(con, src[, min_size, …])	Threshold connectivity using clustering.
`group_connectivity_ttest`(cond1, cond2[, df, …])	Paired t-test comparing connectivity between two conditions.
`cluster_permutation_test`(cond1, cond2, …)	Find significant bundles of connections using a permutation test.

Utilities¶

`get_morph_src_mapping`(src_from, src_to[, …])	Get a mapping between an original source space and its morphed version.
`reg_pinv`(x[, reg, rank, rcond])	Compute a regularized pseudoinverse of a square matrix.