BandPassResult._summary_table#

BandPassResult._summary_table()[source]#

Build the structured summary: the cycle’s variance share per series.

Under a header with the method, series and row counts, and the band; the notes restate the band as frequencies, say what the method cost and where its values are final, and remind that detrending is upstream.

Return type:

SummaryTable

Returns:

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

Example

>>> import numpy as np
>>> t = np.arange(300.0)
>>> y = np.sin(2 * np.pi * t / 12) + np.sin(2 * np.pi * t / 80)
>>> table = BaxterKingFilter().filter(y)._summary_table()
>>> table.columns, table.rows
(('series', 'cycle share of variance'), (('series 1', '55.3%'),))
>>> table.metadata[3]
('Band', '[6, 32] periods')