# -*- coding: utf-8 -*-
""" Imaginary part of Phase Locking Value


Imaginary Phase Locking Value (*IPLV*) was proposed to resolve PLV's sensitivity to
volume conduction and common reference effects.

IPLV is computed similarly as PLV, but taking the imaginary part of the summation:

.. math::
    ImPLV = \\frac{1}{N} \\left | Im \\left ( \\sum_{t=1}^{N} e^{i (\phi_{j1}(t)  - \phi_{j2}(t))} \\right ) \\right |


|

-----

.. [Sadaghiani2012] Sadaghiani, S., Scheeringa, R., Lehongre, K., Morillon, B., Giraud, A. L., D'Esposito, M., & Kleinschmidt, A. (2012). Alpha-band phase synchrony is related to activity in the fronto-parietal adaptive control network. The Journal of Neuroscience, 32(41), 14305-14310.
"""
# Author: Avraam Marimpis <avraam.marimpis@gmail.com>

from .estimator import Estimator
from ..analytic_signal import analytic_signal

import numpy as np


def iplv(data, fb, fs, pairs=None):
    """ Imaginary part of Phase Locking Value

    Compute the Imaginary part of Phase Locking Value for the given *data*,
    between the *pairs* (if given) of channels.


    Parameters
    ----------
    data : array-like, shape(n_channels, n_samples)
        Multichannel recording data.

    fb : list of length 2
        The low and high frequencies.

    fs : float
        Sampling frequency.

    pairs : array-like or `None`
        - If an `array-like` is given, notice that each element is a tuple of length two.
        - If `None` is passed, complete connectivity will be assumed.


    Returns
    -------
    ts : array-like, shape(n_channels, n_channels, n_samples)
        Estimated IPLV time series.

    avg : array-like, shape = [n_electrodes, n_electrodes]
        Average IPLV.
    """
    iplv = IPLV(fb, fs, pairs)
    pp_data = iplv.preprocess(data)

    return iplv.estimate(pp_data)


class IPLV(Estimator):

    def __init__(self, fb, fs, pairs=None):
        """ Imaginary part of PLV (iPLV)


        See also
        --------
        dyfunconn.fc.iplv: Imaginary part of PLV
        dyfunconn.fc.plv: Phase Locking Value
        dyfunconn.tvfcg: Time-Varying Functional Connectivity Graphs
        """
        Estimator.__init__(self, fs, pairs)

        self.fb = fb
        self.fs = fs
        self.data_type = np.complex

    def preprocess(self, data):
        _, _, u_phases = analytic_signal(data, self.fb, self.fs)

        return u_phases

    def estimate_pair(self, ts1, ts2):
        """

        Returns
        -------
        ts : array-like, shape(1, n_samples)
            Estimated iPLV time series.

        avg : float
            Average iPLV.


        Notes
        -----
        Called from :mod:`dyfunconn.tvfcgs.tvfcg`.
        """
        n_samples = len(ts1)

        ts_plv = np.exp(1j * (ts1 - ts2))
        avg_plv = np.abs(np.imag(np.sum((ts_plv)))) / float(n_samples)

        return np.imag(ts_plv), avg_plv

    def mean(self, ts):
        l = float(np.shape(ts)[0])
        return np.abs(np.imgag(np.sum(ts))) / l

    def estimate(self, data):
        """

        Returns
        -------
        ts :

        avg:


        Notes
        -----
        Called from :mod:`dyfunconn.tvfcgs.tvfcg`.
        """
        n_channels, n_samples = np.shape(data)

        ts = np.zeros((n_channels, n_channels, n_samples), dtype=np.complex)
        avg = np.zeros((n_channels, n_channels))

        if self.pairs is None:
            self.pairs = [(r1, r2) for r1 in range(n_channels)
                          for r2 in range(r1, n_channels)
                          if r1 != r2]

        for pair in self.pairs:
            u_phases1, u_phases2 = data[pair, ]
            ts_plv = np.exp(1j * (u_phases1 - u_phases2))
            avg_plv = np.abs(np.imag(np.sum((ts_plv)))) / float(n_samples)

            ts[pair] = ts_plv
            avg[pair] = avg_plv

        return ts, avg

@@ -2806,33 +2806,32 @@
 p.sum((ts_plv)))
-)
  / float(n_sampl
@@ -2825,32 +2825,33 @@
 float(n_samples)
+)
 %0A%0A        return
@@ -2982,13 +2982,13 @@
 ts))
-)
  / l
+)
 %0A%0A  
@@ -3739,17 +3739,16 @@
 s_plv)))
-)
  / float
@@ -3758,16 +3758,17 @@
 samples)
+)
 %0A%0A      

Update computation of average value.