climpred.stats.varweighted_mean_period

Contents

climpred.stats.varweighted_mean_period#

climpred.stats.varweighted_mean_period(da: Union[Dataset, DataArray], dim: Union[str, List[str]] = 'time', **kwargs: Any) → Union[Dataset, DataArray][source]#

Calculate the variance weighted mean period of time series.

$P_{x} = \frac{\sum_k V(f_k,x)}{\sum_k f_k \cdot V(f_k,x)}$

Parameters:

da – input data including dim.
dim – Name of time dimension.
for **kwargs see xrft.power_spectrum

Reference:

Branstator, Grant, and Haiyan Teng. “Two Limits of Initial-Value Decadal Predictability in a CGCM.” Journal of Climate 23, no. 23 (August 27, 2010): 6292-6311. https://doi.org/10/bwq92h.

See also: https://xrft.readthedocs.io/en/latest/api.html#xrft.xrft.power_spectrum