eelbrain.pipeline.MneExperiment.load_neighbor_correlation

MneExperiment.load_neighbor_correlation(subjects=None, epoch=None, add_bads=True, return_data=False, **state)

Load sensor neighbor correlation

Parameters

  • subjects (Union[str, Literal[1, -1], None]) – Subject(s) for which to load data. Can be a single subject name or a group name such as 'all'. 1 to use the current subject; -1 for the current group. Default is current subject (or group if group is specified).

  • epoch (Optional[str]) – Epoch to use for computing neighbor-correlation (by default, the whole session is used).

  • add_bads (bool) – Reject bad channels first.

  • return_data (bool) – Return the data from which the correlation is calculated. Only possible when loading neighbor-correlation for a single subject.

Return type

Union[NDVar, Dataset, Tuple[NDVar, NDVar]]

Returns

  • data (NDVar) – Data from which the correlation is calculated (only retuned with return_data=True).

  • nc (NDVar | Dataset) – Sensor neighbor-correlation as NDVar for a single subject or as Dataset for multiple subjects.