wavPlot {wavScalogram}

Wavelet plots

Description

This function plots a function of two variables (usually times and scales). It is suitable for plotting windowed scalograms, windowed scalogram differences, wavelet coherences and windowed scale indices.

Usage

wavPlot(Z,
               X = NULL,
               Y = NULL,
               Ylog = FALSE,
               Yrev = TRUE,
               zlim = NULL,
               coi = NULL,
               rdist = NULL,
               sig95 = NULL,
               sig05 = NULL,
               Xname = "X",
               Yname = "Y",
               Zname = "Z")

Arguments

Z

A matrix with the images of the function to be plotted.

X

A vector with x-coordinates (times).

Y

A vector with y-coordinates (scales).

Ylog

Logical. Considers logarithmic scale for the y-axis.

Yrev

Logical. Considers reverse the y-axis.

zlim

A vector of length 2 with the limits for the z-axis (the color bar).

coi

A vector of size length(X) with the y-coordinates of the frontier of the cone of influence.

rdist

Numeric. Only for WSD plots, margin in the y-axis where appear border effects.

sig95

Logical matrix with the same size as Z. TRUE if the corresponding point in Z is inside the significance at 95%.

sig05

Logical matrix with the same size as Z. TRUE if the corresponding point in Z is inside the significance at 5%.

Xname

A string with the name of the x-axis.

Yname

A string with the name of the y-axis.

Zname

A string with the name of the function.

Examples

nt <- 1500
time <- 1:nt
sd_noise <-  0.2 #% In Bolós et al. 2017 Figure 1, sd_noise = 1.
signal1 <- rnorm(n = nt, mean = 0, sd = sd_noise) + sin(time / 10)
signal2 <- rnorm(n = nt, mean = 0, sd = sd_noise) + sin(time / 10)
signal2[500:1000] = signal2[500:1000] + sin((500:1000) / 2)
## Not run: 
wsd <- wsd(signal1 = signal1, signal2 = signal2, mc_nrand = 10, makefigure = FALSE)
wavPlot(Z = -log2(wsd$wsd), X = wsd$t, Y = wsd$scales, Ylog = TRUE, coi = wsd$coi,
        rdist = wsd$rdist, sig95 = wsd$signif95, sig05 = wsd$signif05, Xname = "Time",
        Yname = "Scale", Zname = "-log2(WSD)")

## End(Not run)