You are on page 1of 4

functionlist.

tex Last compiled: Monday 22nd January, 2007 11:41

List of functions in the wavelet toolbox.

1 Classical Tools
1.1 Physical-space
Physical-space tools
clip.m - applies a threshold to the input signal
mom.m - pth moment of signal
cmom.m - pth central moment of signal
rms.m - root-mean-square of signal
skew.m - skewness of signal
kurt.m - kurtosis (or flatness) of signal
flat.m - flatness (or kurtosis) of a signal
nmpdf.m - creates a normalized PDF of the input signal
ratio.m - ratio of moments
cmratio.m - ratio of centered moments
corr p.m - cross correlation between two signals
structure function.m - computes the pth order structure function of a signal (1D, from
CD)
gaussianfield2D.m - generate divergence-free vector field (GWN)
gaussianfield2Dspec.m - generate divergence-free random vector field with arbitrary
scaling exponent
pdf centered.m - centered pdf
moving average.m - moving average
nent.m - calculates the entropy of a signal

1.1.1 Other functions


Generation of various academic test signals.
gen dirac.m - generates a dirac test signal
gen sinusoid.m - generates a sinusoid test signal
gen step.m - generates a step test signal
gen wnoise.m - generates a Gaussian white noise test signal

1
functionlist.tex Last compiled: Monday 22nd January, 2007 11:41

1.1.2 Pre-existing MATLAB functions


min.m - minimum of signal (1D)

max.m - maximum of signal (1D)

mean.m - mean of signal (1D)

std.m - standard deviation of signal (1D)

var.m - variance of signal (1D)

1.2 Fourier-space
Fourier-space classical tools.

periodogram.m - calculates the power spectrum density estimate of 1D signal

cross spectrum.m - calculates the cross-spectrum, the power spectrum of the convo-
lution of two signals

conv f.m - fast convolution of two signals by FFT (1D)

corr f.m - fast correlation of two signals by FFT (1D)

energyspectrum2D.m - calculates the energy spectrum of velocity field (2D)

fftdownsample.m - downsamples signal by truncation in Fourier space (1D)

fft2downsample.m -downsamples signal by truncation in Fourier space (2D)

fftupsample.m - up samples signal by zeropadding in Fourier space (1D)

fft2upsample.m -up samples signal by zeropadding in Fourier space (2D)

fftzeropad.m - zero pads matrix of FFT coefficients (1D)

fft2zeropad.m - zero pads matrix of FFT coefficients (2D)

flipks.m - performs operation of k > k for coefficients of 2D fft (fft2.m)

fmodes.m - returns corresponding frequency (k) values of coefficients in order stored for
1D fft

fmodes2.m - returns corresponding frequency (k) values of coefficients in order stored


for 2D fft

filt lin f.m - linear filtering (1D)

filt nonlin f.m - nonlinear filtering (1D)

2
functionlist.tex Last compiled: Monday 22nd January, 2007 11:41

1.2.1 Pre-existing MATLAB functions


The pre-existing MATLAB functions for Fourier-space calculations.

fft.m - 1D discrete FFT

fft2.m - 2D discrete FFT

ifft.m - 1D discrete IFFT

ifft2.m - 2D discrete IFFT

fftshift.m - shifts zero-frequency component of to center of spectrum

2 Wavelet tools
Functions utilizing the wavelet transform.

2.1 Discrete transforms


Functions associated with the discrete wavelet transform:
dwt2D level energy - returns the per level energies of the coefficients of the 2D DWT

dwt levels2D - splits the coefficients of the 2D DWT according to level

extract.m - 1D coherent vortex extraction with iterative method

extract2D.m - 2D coherent vortex extraction with iterative method

extract2D jori.m - 2D coherent vortex extraction with entropy criterion (Joris method)

2.1.1 Wavelab functions


Functions coming directly from the wavelab library of matlab scripts.

makeONFilter.m - generates the filter coefficients for the discrete wavelet transforms
(from wavelab)

FWT PO.m - Calculates the coefficients of the discrete Forward Wavelet Transform,
periodic, orthogonal (from wavelab)

IWT PO.m - Reconstructs the signal from the coefficients of the discrete forward
wavelet transform (from wavelab)

DownDyadHi.m - High-pass dyadic downsampling (from wavelab)

DownDyadLo.m - Low-pass dyadic downsampling (from wavelab)

UpDyadHi.m - High-pass dyadic upsampling (from wavelab)

UpDyadLo.m - Low-pass dyadic upsampling (from wavelab)

3
functionlist.tex Last compiled: Monday 22nd January, 2007 11:41

dyad.m - indices of jth dyad (from wavelab)

dyadlength.m - nearest dyad length of input vector (from wavelab)

ShapeAsRow.m - convert to row vector (from wavelab)

ShapeLike.m - return vector of shape of input (from wavelab)

reverse.m - reverse order of 1D vector (from wavelab)

2.2 Continuous wavelet transforms


Functions involving the continuous wavelet transform (CWT).

cwscale.m - converts between the various scales of the CWT (i.e. a, k, l)

cwt1D.m - returns the 1D CWT coefficients of a signal, using either the complex Morlet
or mexican hat wavelet

wphase.m - calculates the phase of the wavelet coefficients

ICWT mexh.m - Inverse CWT using the mexican hat wavelet (needs more testing)

ICWT P.m - Inverse CWT (testing needed)

cwt2D.m - returns the coefficients of a 2D CWT with the complex Morlet wavelet

intfactor2D.m - calculates the intermittency factor of the 2D CWT coefficients

wmorlet.m - matlab literal translation of Maries 2D CWT code (c. 1990)

wmorlet matlab.m - matlab optimized translation of Maries 2D CWT code (c. 1990)

Generating wavelets:

gen cmorlet2D.m - generate a 2D complex Morlet wavelet

gen cmorlet.m - generate a 1D complex Morlet wavelet

gen mexh.m - generate a 1D mexican hat wavelet

Plotting functions:

drawCWT1D.m - plots the 1D CWT coefficients with spectra

drawCWT2D.m - plots the 2D CWT coefficients (not finished / needs improvement)

plot morlet and spectrum.m - GUI to plot the complex Morlet wavelet and its Fourier
spectrum for different parameters of the wavelet (wavenumber, scale, and transla-
tion)