diff --git a/pyleoclim/core/series.py b/pyleoclim/core/series.py index fb18ceb7..b32d5c9e 100644 --- a/pyleoclim/core/series.py +++ b/pyleoclim/core/series.py @@ -3201,7 +3201,21 @@ def wavelet_coherence(self, target_series, method='cwt', settings=None, coh_wwz.plot() As with wavelet analysis, both CWT and WWZ admit optional arguments through `settings`. - Significance is assessed similarly as with PSD or Scalogram objects: + For instance, one can adjust the resolution of the time axis on which coherence is evaluated: + + .. jupyter-execute:: + + coh_wwz = ts_air.wavelet_coherence(ts_nino, method = 'wwz', settings = {'ntau':20}) + coh_wwz.plot() + + The frequency (scale) axis can also be customized, e.g. to focus on scales from 1 to 20y, with 24 scales: + + .. jupyter-execute:: + + coh = ts_air.wavelet_coherence(ts_nino, freq_kwargs={'fmin':1/20,'fmax':1,'nf':24}) + coh.plot() + + Significance is assessed similarly to PSD or Scalogram objects: .. jupyter-execute:: @@ -3219,6 +3233,8 @@ def wavelet_coherence(self, target_series, method='cwt', settings=None, cwt_sig.dashboard() Note: this design balances many considerations, and is not easily customizable. + + ''' if not verbose: warnings.simplefilter('ignore')