Skip to content

Kuramoto Order Parameter

doKuramoto(N, Tmax, phases, base=2, nBits=8)

Dynamic Phase-Locking.

This fuction returns the dynamic Phase-Locking for all parcels/voxels of the input.

Parameters:

Name Type Description Default
N int

Number of parcels/voxels of the input array.

 required
Tmax int

BOLD signal samples count.

 required
phases ndarray

Phases signal array for all parcels/voxels in the format [N, Tmax].

 required
base double

Base for obtaining Shannon entropy.

 2
nBits int

n

 8
Return

tuple: syncAux : Synchronicity matrix for all parcels/voxels in the format [N, N], metastabAux : Metastability index - Standard deviation of Kuramoto Parameter

References

.. [1]

Source code in dynfc/doKuramoto.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
def doKuramoto(N, Tmax, phases, base = 2, nBits = 8):
    """Dynamic Phase-Locking.

    This fuction returns the dynamic Phase-Locking for all parcels/voxels
    of the input.

    Args:
        N (int): Number of parcels/voxels of the input array.
        Tmax (int): BOLD signal samples count.
        phases (ndarray): Phases signal array for all parcels/voxels in the format [N, Tmax].
        base (double, optional): Base for obtaining Shannon entropy.
        nBits (int, optional): n

    Return:
        tuple:
            syncAux : Synchronicity matrix for all parcels/voxels in the format [N, N], 
            metastabAux : Metastability index - Standard deviation of Kuramoto Parameter

    References
    ----------

    .. [1] 


    """

    T = arange(10, Tmax - 10)

    syncAux = zeros([len(T), 1])

    for t in range(0, len(T)):

        ku = sum(cos(phases[:, T[t]]) + 1j * sin(phases[:, T[t]])) / N
        syncAux[t] = abs(ku)

    metastabAux = std(syncAux)
    shEntropy = getEntropy(syncAux[:,0], base, nBits)

    return metastabAux, syncAux, shEntropy