wavelet_radius: Wavelet radius

Description Usage Arguments Value Examples

View source: R/wavelet_radius.R

Description

This function computes an approximation of the effective radius of a mother wavelet.

Usage

1
2
3
4
5
6
wavelet_radius(wname = c("MORLET", "DOG", "PAUL", "HAAR", "HAAR2"),
                      wparam = NULL,
                      perc = .0025,
                      scale = 100,
                      n = 1000,
                      makefigure = FALSE)

Arguments

wname

A string, equal to "MORLET", "DOG", "PAUL", "HAAR" or "HAAR2". The difference between "HAAR" and "HAAR2" is that "HAAR2" is more accurate but slower.

wparam

The corresponding nondimensional parameter for the wavelet function (Morlet, DoG or Paul).

perc

Numeric. The wavelet radius is computed so that the area covered is at least the 100*(1-perc)% of the total area of the mother wavelet.

scale

Numeric. Scale of the wavelet used in the computations. It only affects the accuracy.

n

Numeric. The computations use a time series of length 2n+1.

makefigure

Logical. Plots a figure with the real part of the mother wavelet and its modulus.

Value

A list with the following fields:

Examples

1
waverad <- wavelet_radius(wname = "MORLET", makefigure = TRUE)

wavScalogram documentation built on May 24, 2019, 5:03 p.m.