MODWTResult._summary_table#

MODWTResult._summary_table()[source]#

Variance by scale with its band and share.

One row per level: period band, wavelet variance, its 95% band, its share of the total (levels’ variances plus the smooth’s), and the degrees of freedom; a closing row for the smooth. The notes state the circular boundary treatment, the conservatism of the bands, and the exact additivity of the components.

Return type:

SummaryTable

Returns:

The SummaryTable.

Example

>>> rng = np.random.default_rng(0)
>>> table = MODWT(wavelet="haar", levels=3).transform(rng.standard_normal(256))
>>> table = table._summary_table()
>>> table.columns
('level', 'period band', 'variance', '95% band', 'share', 'dof')
>>> table.rows[0]
('D1', '2-4', '0.4935', '[0.392, 0.641]', '50.3%', '128')
>>> table.rows[-1][:2]
('S3', '>16')