- signal
A vector containing the signal whose windowed scale indices are wanted.
- wsc
A matrix containing the windowed scalograms from which the windowed scale
indices are going to be computed (number of times x number of scales, as it is returned
by the windowed_scalogram function). If wsc is not NULL, then
signal, windowrad, delta_t, waverad and
border_effects are not necessary and they are ignored.
- wsc_coi
A vector of length nrow(wsc) (i.e. number of times) containing
the values of the maximum scale at each time from which there are border effects in the
windowed scalogram wsc. If wsc is NULL, then wsc_coi is not
necessary and it is ignored.
- dt
Numeric. The time step of the signal.
- scales
A vector containing the wavelet scales at wich the windowed scalograms
are computed. This can be either a vector with all the scales or, following Torrence
and Compo 1998, a vector of 3 elements with the minimum scale, the maximum scale and
the number of suboctaves per octave. In the first case, powerscales must be
FALSE if the given scales are not power 2 scales. In the second case,
powerscales must be TRUE in order to construct power 2 scales using a
base 2 logarithmic scale). If scales is NULL, they are automatically constructed.
- powerscales
Logical. It must be TRUE (default) only in these cases:
If scales are power 2 scales, i.e. they use a base 2 logarithmic scale.
If we want to construct power 2 scales automatically. In this case, scales
must be NULL.
If we want to construct power 2 scales from scales. In this case,
length(scales) must be 3.
Otherwise, it must be FALSE.
- s1
A vector containing the scales \(s_1\). The windowed scale indices are
computed in the intervals \([s_0,s_1]\), where \(s_0\) is the minimum scale in
scales. If s1 are not power 2 scales, then scales should not be
power 2 scales either and hence, powerscales must be FALSE.
- windowrad
Integer. Time radius for the windows, measured in dt. By default,
it is set to \(ceiling(length(signal) / 20)\).
- delta_t
Integer. Increment of time for the construction of windows central
times, measured in dt. By default, it is set to
\(ceiling(length(signal) / 256)\).
- 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).
- waverad
Numeric. The radius of the wavelet used in the computations for the cone
of influence. If it is not specified, it is asumed to be \(\sqrt{2}\) for Morlet and DoG,
\(1/\sqrt{2}\) for Paul and 0.5 for Haar.
- border_effects
A string, equal to "BE", "INNER", "PER" or "SYM", which indicates
how to manage the border effects which arise usually when a convolution is performed on
finite-lenght signals.
"BE": With border effects, padding time series with zeroes.
"INNER": Normalized inner scalogram with security margin adapted for each
different scale.
"PER": With border effects, using boundary wavelets (periodization of the
original time series).
"SYM": With border effects, using a symmetric catenation of the original time
series.
- makefigure
Logical. If TRUE (default), a figure with the windowed scale indices
is plotted.
- time_values
A numerical vector of length length(signal) containing custom
time values for the figure. If NULL (default), it will be computed starting at 0.
- figureperiod
Logical. If TRUE (default), periods are used in the figure instead
of scales.
- plot_wsc
Logical. If TRUE, it plots the windowed scalograms from which the
windowed scale indices are computed.
- xlab
A string giving a custom X axis label.
- ylab
A string giving a custom Y axis label. If NULL (default) the Y label is
either "s1" or "Period of s1" depending on the value of figureperiod if
length(s1) > 1, or "Windowed Scale Index" if length(s1) == 1.
- main
A string giving a custom main title for the figure.
- zlim
A vector of length 2 with the limits for the z-axis (the color bar).