frites.core.mi_1d_gg

frites.core.mi_1d_gg(x, y, biascorrect=True, demeaned=False)

Mutual information (MI) between two Gaussian variables in bits.

I = mi_gg(x,y) returns the MI between two (possibly multidimensional) Gaussian variables, x and y, with bias correction.

Parameters:

x, ynumpy:array_like

Gaussian arrays of shape (n_epochs,) or (n_dimensions, n_epochs)

biascorrectbool | True

Specifies whether bias correction should be applied to the estimated MI

demeanedbool | False

Specifies whether the input data already has zero mean (true if it has been copula-normalized)

Returns:

ifloat

Information shared by x and y (in bits)