phyid.calculate.calc_PhiID

phyid.calculate.calc_PhiID(src, trg, tau, kind='gaussian', redundancy='MMI')[source]

Calculate the information decompositions.

This function calculates the information decompositions of two time series.

Parameters:

  • src ((N,) array_like) – Source time series.

  • trg ((N,) array_like) – Target time series.

  • tau (int) – Time lag.

  • kind (str, optional) – PhiID kind to calculate, by default “gaussian”.

  • redundancy (str, optional) – Redundancy measure to use, by default “MMI”.

Returns:

  • atoms_res (dict) – Dictionary with the atoms of the decomposition.

  • calc_res (dict) – Dictionary with the intermediate calculations.