mne.stats.summarize_clusters_stc#

mne.stats.summarize_clusters_stc(clu, p_thresh=0.05, tstep=1.0, tmin=0, subject='fsaverage', vertices=None)[source]#

Assemble summary SourceEstimate from spatiotemporal cluster results.

This helps visualizing results from spatio-temporal-clustering permutation tests.

Parameters:

clutuple: The output from clustering permutation tests.
p_threshfloat: The significance threshold for inclusion of clusters.
tstepfloat: The time step between samples of the original STC, in seconds (i.e., 1 / stc.sfreq). Defaults to 1, which will yield a colormap indicating cluster duration measured in samples rather than seconds.
tminfloat | int: The time of the first sample.
subjectstr: The name of the subject.
verticeslist of array | instance of SourceSpaces | None: The vertex numbers associated with the source space locations. Defaults to None. If None, equals [np.arange(10242), np.arange(10242)]. Can also be an instance of SourceSpaces to get vertex numbers from.

Changed in version 0.21: Added support for SourceSpaces.

Returns:

outinstance of SourceEstimate: A summary of the clusters. The first time point in this SourceEstimate object is the summation of all the clusters. Subsequent time points contain each individual cluster. The magnitude of the activity corresponds to the duration spanned by the cluster (duration units are determined by tstep).

Changed in version 0.21: Added support for volume and mixed source estimates.

Examples using `mne.stats.summarize_clusters_stc`#