WaveletCoherenceResult._summary_table#

WaveletCoherenceResult._summary_table()[source]#

Mean coherence and lead per octave, outside the cone of influence.

One row per octave of period (2-4, 4-8, …): mean squared coherence, mean lead in observations, and – when surrogates were run – the share of dates above the significance level. Octaves with no date outside the cone are omitted.

Return type:

SummaryTable

Returns:

The SummaryTable.

Example

>>> t = np.arange(256.0)
>>> x = np.sin(2 * np.pi * t / 16)
>>> y = np.sin(2 * np.pi * (t - 2) / 16)
>>> res = WaveletCoherence(per_octave=4, surrogates=0).compute(x, y)
>>> table = res._summary_table()
>>> table.columns
('period band', 'mean coherence', 'lead', 'share significant')
>>> [row[0] for row in table.rows]
['2-4', '4-8', '8-16', '16-32', '32-64', '64-128']
>>> table.notes[-1]
'No surrogate significance level was computed (surrogates=0).'