TurningPointsResult._summary_table#

TurningPointsResult._summary_table()[source]#

Average duration, amplitude and excess by phase type.

One row for contractions and one for expansions, each with the count and the means over the completed phases of that type, under a header listing the turn dates and the cycle and observation counts; the notes restate the rules and the share of dates in contraction, define amplitude and excess, and say what the ends of the sample cannot show.

Return type:

SummaryTable

Returns:

The SummaryTable that summary(), str(), and the notebook renderer display.

Example

>>> import numpy as np
>>> t = np.arange(120.0)
>>> res = TurningPoints().date(0.01 * t + 0.5 * np.sin(2 * np.pi * t / 24))
>>> table = res._summary_table()
>>> table.columns
('phase', 'count', 'mean duration', 'mean amplitude', 'mean excess')
>>> table.rows[0][:3], table.metadata[2]
(('contraction', '5', '12.0'), ('Completed cycles', '4'))