SpectrumEstimate._summary_table#

SpectrumEstimate._summary_table()[source]#

Peak and variance per series, with the estimate’s resolution.

One row per series: the interior frequency of largest power, its period, and twice the trapezoidal integral of the spectrum (the variance the estimate accounts for). The notes state the degrees of freedom and resolution, that the object is model-free, and that the peak search excludes the origin.

Return type:

SummaryTable

Returns:

The SummaryTable.

Example

>>> rng = np.random.default_rng(0)
>>> t = np.arange(512.0)
>>> y = np.cos(2 * np.pi * t / 16) + 0.3 * rng.standard_normal(512)
>>> table = MultitaperSpectrum(y).compute()._summary_table()
>>> table.title, table.columns
('Multitaper Spectrum', ('series', 'peak frequency', 'peak period', 'variance'))
>>> table.rows[0][:3]
('y', '0.3927', '16.0')