braindecode.functional.plv_time#
- braindecode.functional.plv_time(x, forward_fourier=True, epsilon=1e-06)[source]#
Compute the Phase Locking Value (PLV) metric in the time domain.
The Phase Locking Value (PLV) is a measure of the synchronization between different channels by evaluating the consistency of phase differences over time. It ranges from 0 (no synchronization) to 1 (perfect synchronization) [Lachaux1999].
- Parameters:
x (torch.Tensor) –
Input tensor containing the signal data.
If forward_fourier is True, the shape should be (…, channels, time).
If forward_fourier is False, the shape should be (…, channels, freqs, 2), where the last dimension represents the real and imaginary parts.
forward_fourier (bool, optional) –
Specifies the format of the input tensor x.
If True, x is assumed to be in the time domain.
If False, x is assumed to be in the Fourier domain with separate real and imaginary components.
Default is True.
epsilon (float, default 1e-6) – Small numerical value to ensure positivity constraint on the complex part
- Returns:
plv – The Phase Locking Value matrix with shape (…, channels, channels). Each element [i, j] represents the PLV between channel i and channel j.
- Return type:
References
[Lachaux1999]Lachaux, J. P., Rodriguez, E., Martinerie, J., & Varela, F. J. (1999). Measuring phase synchrony in brain signals. Human brain mapping, 8(4), 194-208.