borsar.cluster.read_cluster

borsar.cluster.read_cluster(fname, subjects_dir=None, src=None, info=None)[source]

Read standard Clusters .hdf5 file and return Clusters object. You need to pass correct subjects_dir and src to read_cluster if your results are in source space or correct info if your results are in channel space.

Parameters:
fname : str

File path for the file to read.

subjects_dir : str, optional

Path to Freesurfer subjects directory.

src : mne.SourceSpaces, optional

Source space that the results are reprseneted in.

info : mne.Info, optional

Channel space that the results are respresented in.

Returns:
clst : Clusters

Cluster results read from file.