C09 Chapter Contents
C09 Chapter Introduction
NAG Library Manual

# NAG Library Routine DocumentC09CCF

Note:  before using this routine, please read the Users' Note for your implementation to check the interpretation of bold italicised terms and other implementation-dependent details.

## 1  Purpose

C09CCF computes the one-dimensional multi-level discrete wavelet transform (DWT). The initialization routine C09AAF must be called first to set up the DWT options.

## 2  Specification

 SUBROUTINE C09CCF ( N, X, LENC, C, NWL, DWTLEV, ICOMM, IFAIL)
 INTEGER N, LENC, NWL, DWTLEV(NWL+1), ICOMM(100), IFAIL REAL (KIND=nag_wp) X(N), C(LENC)

## 3  Description

C09CCF computes the multi-level DWT of one-dimensional data. For a given wavelet and end extension method, C09CCF will compute a multi-level transform of a data array, ${x}_{\mathit{i}}$, for $\mathit{i}=1,2,\dots ,n$, using a specified number, ${n}_{l}$, of levels. The number of levels specified, ${n}_{l}$, must be no more than the value ${l}_{\mathrm{max}}$ returned in NWL by the initialization routine C09AAF for the given problem. The transform is returned as a set of coefficients for the different levels (packed into a single array) and a representation of the multi-level structure.
The notation used here assigns level $0$ to the input dataset, $x$, with level $1$ being the first set of coefficients computed, with the detail coefficients, ${d}_{1}$, being stored while the approximation coefficients, ${a}_{1}$, are used as the input to a repeat of the wavelet transform. This process is continued until, at level ${n}_{l}$, both the detail coefficients, ${d}_{{n}_{l}}$, and the approximation coefficients, ${a}_{{n}_{l}}$ are retained. The output array, $C$, stores these sets of coefficients in reverse order, starting with ${a}_{{n}_{l}}$ followed by ${d}_{{n}_{l}},{d}_{{n}_{l}-1},\dots ,{d}_{1}$.

None.

## 5  Parameters

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 routine C09AAF.
2:     X(N) – REAL (KIND=nag_wp) arrayInput
On entry: X contains the one-dimensional input dataset ${x}_{\mathit{i}}$, for $\mathit{i}=1,2,\dots ,n$.
3:     LENC – INTEGERInput
On entry: the dimension of the array C as declared in the (sub)program from which C09CCF is called. C must be large enough to contain the number, ${n}_{c}$, of wavelet coefficients. The maximum value of ${n}_{c}$ is returned in NWC by the call to the initialization routine C09AAF and corresponds to the DWT being continued for the maximum number of levels possible for the given data set. When the number of levels, ${n}_{l}$, is chosen to be less than the maximum, then ${n}_{c}$ is correspondingly smaller and LENC can be reduced by noting that the number of coefficients at each level is given by $⌈\stackrel{-}{n}/2⌉$ for ${\mathbf{MODE}}=\text{'P'}$ in C09AAF and $⌊\left(\stackrel{-}{n}+{n}_{f}-1\right)/2⌋$ for ${\mathbf{MODE}}=\text{'H'}$, $\text{'W'}$ or $\text{'Z'}$, where $\stackrel{-}{n}$ is the number of input data at that level and ${n}_{f}$ is the filter length provided by the call to C09AAF. At the final level the storage is doubled to contain the set of approximation coefficients.
Constraint: ${\mathbf{LENC}}\ge {n}_{c}$, where ${n}_{c}$ is the number of approximation and detail coefficients that correspond to a transform with NWL levels.
4:     C(LENC) – REAL (KIND=nag_wp) arrayOutput
On exit: let $q\left(\mathit{i}\right)$ denote the number of coefficients (of each type) produced by the wavelet transform at level $\mathit{i}$, for $\mathit{i}={n}_{l},{n}_{l}-1,\dots ,1$. These values are returned in DWTLEV. Setting ${k}_{1}=q\left({n}_{l}\right)$ and ${k}_{\mathit{j}+1}={k}_{\mathit{j}}+q\left({n}_{l}-\mathit{j}+1\right)$, for $\mathit{j}=1,2,\dots ,{n}_{l}$, the coefficients are stored as follows:
${\mathbf{C}}\left(\mathit{i}\right)$, for $\mathit{i}=1,2,\dots ,{k}_{1}$
Contains the level ${n}_{l}$ approximation coefficients, ${a}_{{n}_{l}}$.
${\mathbf{C}}\left(\mathit{i}\right)$, for $\mathit{i}={k}_{1}+1,\dots ,{k}_{2}$
Contains the level ${n}_{l}$ detail coefficients ${d}_{{n}_{l}}$.
${\mathbf{C}}\left(\mathit{i}\right)$, for $\mathit{i}={k}_{j}+1,\dots ,{k}_{j+1}$
Contains the level ${n}_{l}-\mathit{j}+1$ detail coefficients, for $\mathit{j}=2,3,\dots ,{n}_{l}$.
5:     NWL – INTEGERInput
On entry: the number of levels, ${n}_{l}$, in the multi-level resolution to be performed.
Constraint: $1\le {\mathbf{NWL}}\le {l}_{\mathrm{max}}$, where ${l}_{\mathrm{max}}$ is the value returned in NWL (the maximum number of levels) by the call to the initialization routine C09AAF.
6:     DWTLEV(${\mathbf{NWL}}+1$) – INTEGER arrayOutput
On exit: the number of transform coefficients at each level. ${\mathbf{DWTLEV}}\left(1\right)$ and ${\mathbf{DWTLEV}}\left(2\right)$ contain the number, $q\left({n}_{l}\right)$, of approximation and detail coefficients respectively, for the final level of resolution (these are equal); ${\mathbf{DWTLEV}}\left(\mathit{i}\right)$ contains the number of detail coefficients, $q\left({n}_{l}-\mathit{i}+2\right)$, for the (${n}_{l}-\mathit{i}+2$)th level, for $\mathit{i}=3,4,\dots ,{n}_{l}+1$.
7:     ICOMM($100$) – INTEGER arrayCommunication Array
On entry: contains details of the discrete wavelet transform and the problem dimension as setup in the call to the initialization routine C09AAF.
On exit: contains additional information on the computed transform.
8:     IFAIL – INTEGERInput/Output
On entry: IFAIL must be set to $0$, $-1\text{​ or ​}1$. If you are unfamiliar with this parameter you should refer to Section 3.3 in the Essential Introduction for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value $-1\text{​ or ​}1$ is recommended. If the output of error messages is undesirable, then the value $1$ is recommended. Otherwise, if you are not familiar with this parameter, the recommended value is $0$. When the value $-\mathbf{1}\text{​ or ​}\mathbf{1}$ is used it is essential to test the value of IFAIL on exit.
On exit: ${\mathbf{IFAIL}}={\mathbf{0}}$ unless the routine detects an error or a warning has been flagged (see Section 6).

## 6  Error Indicators and Warnings

If on entry ${\mathbf{IFAIL}}={\mathbf{0}}$ or $-{\mathbf{1}}$, explanatory error messages are output on the current error message unit (as defined by X04AAF).
Errors or warnings detected by the routine:
${\mathbf{IFAIL}}=1$
On entry, N is inconsistent with the value passed to the initialization routine C09AAF.
${\mathbf{IFAIL}}=3$
On entry, ${\mathbf{LENC}}<{n}_{c}^{*}$, where ${n}_{c}^{*}$ is the number of coefficients that will be generated given the chosen value of NWL.
${\mathbf{IFAIL}}=5$
 On entry, ${\mathbf{NWL}}<1$, or ${\mathbf{NWL}}>{l}_{\mathrm{max}}$, where ${l}_{\mathrm{max}}$ is the value returned in NWL by the call to the initialization routine C09AAF.
${\mathbf{IFAIL}}=7$
On entry, the initialization routine C09AAF has not been called first or it has been called with ${\mathbf{WTRANS}}=\text{'S'}$, or the communication array ICOMM has become corrupted.

## 7  Accuracy

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.

## 8  Further Comments

The wavelet coefficients at each level can be extracted from the output array C using the information contained in DWTLEV on exit (see the descriptions of C and DWTLEV in Section 5). For example, given an input data set, $x$, denoising can be carried out by applying a thresholding operation to the detail coefficients at every level. The elements ${\mathbf{C}}\left({k}_{1}+1:{k}_{{n}_{l}+1}\right)$, as described in Section 5, contain the detail coefficients, ${\stackrel{^}{d}}_{\mathit{i}\mathit{j}}$, for $\mathit{i}={n}_{l},{n}_{l}-1,\dots ,1$ and $\mathit{j}=1,2,\dots ,q\left(i\right)$, where ${\stackrel{^}{d}}_{ij}={d}_{ij}+\sigma {\epsilon }_{ij}$ and $\sigma {\epsilon }_{ij}$ is the transformed noise term. If some threshold parameter $\alpha$ is chosen, a simple hard thresholding rule can be applied as
 $d- ij = 0, if ​ d^ij ≤ α d^ij , if ​ d^ij > α,$
taking ${\stackrel{-}{d}}_{ij}$ to be an approximation to the required detail coefficient without noise, ${d}_{ij}$. The resulting coefficients can then be used as input to C09CDF in order to reconstruct the denoised signal.
See the references given in the introduction to this chapter for a more complete account of wavelet denoising and other applications.

## 9  Example

This example performs a multi-level resolution of a dataset using the Daubechies wavelet (see ${\mathbf{WAVNAM}}=\text{'DB4'}$ in C09AAF) using zero end extensions, the number of levels of resolution, the number of coefficients in each level and the coefficients themselves are reused. The original dataset is then reconstructed using C09CDF.

### 9.1  Program Text

Program Text (c09ccfe.f90)

### 9.2  Program Data

Program Data (c09ccfe.d)

### 9.3  Program Results

Program Results (c09ccfe.r)