NAG C Library Function Document

nag_mlmodwt (c09dcc)


nag_mlmodwt (c09dcc) computes the one-dimensional multi-level maximal overlap discrete wavelet transform (MODWT). The initialization function nag_wfilt (c09aac) must be called first to set up the MODWT options.


#include <nag.h>
#include <nagc09.h>
void  nag_mlmodwt (Integer n, const double x[], Nag_WaveletCoefficients keepa, Integer lenc, double c[], Integer nwl, Integer *na, Integer icomm[], NagError *fail)


nag_mlmodwt (c09dcc) computes the multi-level MODWT for a data set, xi, for i=1,2,,n, in one dimension. For a chosen number of levels, nl, with nllmax, where lmax is returned by the initialization function nag_wfilt (c09aac) in nwlmax, the transform is returned as a set of coefficients for the different levels stored in a single array. Periodic reflection is currently the only available end extension method to reduce the edge effects caused by finite data sets.
The argument keepa can be set to retain both approximation and detail coefficients at each level resulting in nl×na+nd coefficients being returned in the output array, c, where na is the number of approximation coefficients and nd is the number of detail coefficients. Otherwise, only the detail coefficients are stored for each level along with the approximation coefficients for the final level, in which case the length of the output array, c, is na+nl×nd. In the present implementation, for simplicity, na and nd are chosen to be equal by adding zero padding to the wavelet filters where necessary.


Percival D B and Walden A T (2000) Wavelet Methods for Time Series Analysis Cambridge University Press


1:     n IntegerInput
On entry: the number of elements, n, in the data array x.
Constraint: this must be the same as the value n passed to the initialization function nag_wfilt (c09aac).
2:     x[n] const doubleInput
On entry: x contains the input dataset xi, for i=1,2,,n.
3:     keepa Nag_WaveletCoefficientsInput
On entry: determines whether the approximation coefficients are stored in array c for every level of the computed transform or else only for the final level. In both cases, the detail coefficients are stored in c for every level computed.
Retain approximation coefficients for all levels computed.
Retain approximation coefficients for only the final level computed.
Constraint: keepa=Nag_StoreAll or Nag_StoreFinal.
4:     lenc IntegerInput
On entry: the dimension of the array c. c must be large enough to contain the number of wavelet coefficients.
If keepa=Nag_StoreFinal, the total number of coefficients, nc, is returned in nwc by the call to the initialization function nag_wfilt (c09aac) and corresponds to the MODWT being continued for the maximum number of levels possible for the given data set. When the number of levels, nl, is chosen to be less than the maximum, then the number of stored coefficients is correspondingly smaller and lenc can be reduced by noting that nd detail coefficients are stored at each level, with the storage increased at the final level to contain the na approximation coefficients.
If keepa=Nag_StoreAll, nd detail coefficients and na approximation coefficients are stored for each level computed, requiring lencnl×na+nd=2×nl×na, since the numbers of stored approximation and detail coefficients are equal. The number of approximation (or detail) coefficients at each level, na, is returned in na.
  • if keepa=Nag_StoreFinal, lencnl+1×na;
  • if keepa=Nag_StoreAll, lenc2×nl×na.
5:     c[lenc] doubleOutput
On exit: the coefficients of a multi-level wavelet transform of the dataset.
The coefficients are stored in c as follows:
If keepa=Nag_StoreFinal,
Contains the level nl approximation coefficients;
C na + i-1 × nd+1 : na + i × nd
Contains the level nl-i+1 detail coefficients, for i=1,2,,nl;
If keepa=Nag_StoreAll,
Contains the level nl-i+1 approximation coefficients, for i=1,2,,nl;
Contains the level i detail coefficients, for i=1,2,,nl;
The values na and nd denote the numbers of approximation and detail coefficients respectively, which are equal and returned in na.
6:     nwl IntegerInput
On entry: the number of levels, nl, in the multi-level resolution to be performed.
Constraint: 1nwllmax, where lmax is the value returned in nwlmax (the maximum number of levels) by the call to the initialization function nag_wfilt (c09aac).
7:     na Integer *Output
On exit: na contains the number of approximation coefficients, na, at each level which is equal to the number of detail coefficients, nd. With periodic end extension (mode=Nag_Periodic in nag_wfilt (c09aac)) this is the same as the length, n, of the data array, x.
8:     icomm[100] IntegerCommunication Array
On entry: contains details of the discrete wavelet transform and the problem dimension as setup in the call to the initialization function nag_wfilt (c09aac).
On exit: contains additional information on the computed transform.
9:     fail NagError *Input/Output
The NAG error argument (see Section 3.7 in How to Use the NAG Library and its Documentation).

Error Indicators and Warnings

Dynamic memory allocation failed.
See Section in How to Use the NAG Library and its Documentation for further information.
On entry, lenc is set too small: lenc=value.
Constraint: lencvalue.
On entry, argument value had an illegal value.
On entry, n is inconsistent with the value passed to the initialization function: n=value, n should be value.
On entry, nwl is larger than the maximum number of levels returned by the initialization function: nwl=value, maximum = value.
On entry, the initialization function nag_wfilt (c09aac) has not been called first or it has not been called with wtrans=Nag_MODWTMulti, or the communication array icomm has become corrupted.
On entry, nwl=value.
Constraint: nwl1.
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.
See Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.
Your licence key may have expired or may not have been installed correctly.
See Section 2.7.5 in How to Use the NAG Library and its Documentation for further information.


The accuracy of the wavelet transform depends only on the floating-point operations used in the convolution and downsampling and should thus be close to machine precision.

Parallelism and Performance

nag_mlmodwt (c09dcc) is not threaded in any implementation.

Further Comments

The wavelet coefficients at each level can be extracted from the output array c using the information contained in na on exit.


A set of data values (n=64) is decomposed using the MODWT over two levels and then the inverse (nag_imlmodwt (c09ddc)) is applied to restore the original data set.

Program Text

Program Text (c09dcce.c)

Program Data

Program Data (c09dcce.d)

Program Results

Program Results (c09dcce.r)