NAG Library Routine Document

c09cdf  (dim1_multi_inv)

 Contents

    1  Purpose
    7  Accuracy
    10  Example

1
Purpose

c09cdf computes the inverse one-dimensional multi-level discrete wavelet transform (DWT). This routine reconstructs data from (possibly filtered or otherwise manipulated) wavelet transform coefficients calculated by c09ccf from an original set of data. The initialization routine c09aaf must be called first to set up the DWT options.

2
Specification

Fortran Interface
Subroutine c09cdf ( nwlinv, lenc, c, n, y, icomm, ifail)
Integer, Intent (In):: nwlinv, lenc, n, icomm(100)
Integer, Intent (Inout):: ifail
Real (Kind=nag_wp), Intent (In):: c(lenc)
Real (Kind=nag_wp), Intent (Out):: y(n)
C Header Interface
#include nagmk26.h
void  c09cdf_ ( const Integer *nwlinv, const Integer *lenc, const double c[], const Integer *n, double y[], const Integer icomm[], Integer *ifail)

3
Description

c09cdf performs the inverse operation of c09ccf. That is, given a set of wavelet coefficients, computed up to level nfwd by c09ccf using a DWT as set up by the initialization routine c09aaf, on a real data array of length n, c09cdf will reconstruct the data array yi, for i=1,2,,n, from which the coefficients were derived. If the original input dataset is level 0, then it is possible to terminate reconstruction at a higher level by specifying fewer than the number of levels used in the call to c09ccf. This results in a partial reconstruction.

4
References

None.

5
Arguments

1:     nwlinv – IntegerInput
On entry: the number of levels to be used in the inverse multi-level transform. The number of levels must be less than or equal to nfwd, which has the value of argument nwl as used in the computation of the wavelet coefficients using c09ccf. The data will be reconstructed to level nwl-nwlinv, where level 0 is the original input dataset provided to c09ccf.
Constraint: 1nwlinvnwl, where nwl is the value used in a preceding call to c09ccf.
2:     lenc – IntegerInput
On entry: the dimension of the array c as declared in the (sub)program from which c09cdf is called.
Constraint: lencnc, where nc is the total number of coefficients that correspond to a transform with nwlinv levels and is unchanged from the preceding call to c09ccf.
3:     clenc – Real (Kind=nag_wp) arrayInput
On entry: the coefficients of a multi-level wavelet transform of the dataset.
Let qi be the number of coefficients (of each type) at level i, for i=nfwd,nfwd-1,,1. Then, setting k1=qnfwd and kj+1=kj+qnfwd-j+1, for j=1,2,,nfwd, the coefficients are stored in c as follows:
ci, for i=1,2,,k1
Contains the level nfwd approximation coefficients, anfwd.
ci, for i=k1+1,,k2
Contains the level nfwd detail coefficients dnfwd.
ci, for i=kj+1,,kj+1
Contains the level nfwd-j+1 detail coefficients, for j=2,3,,nfwd.
The values qi, for i=nfwd,nfwd-1,,1, are contained in dwtlev which is produced as output by a preceding call to c09ccf. See c09ccf for details.
4:     n – IntegerInput
On entry: n, the length of the data array, y, to be reconstructed. For a full reconstruction of nwl levels, where nwl is as supplied to c09ccf, this must be the same as argument n used in the call to c09ccf. For a partial reconstruction of nwlinv<nwl, this must be equal to dwtlevnwlinv+2, as returned from c09ccf.
5:     yn – Real (Kind=nag_wp) arrayOutput
On exit: the dataset reconstructed from the multi-level wavelet transform coefficients and the transformation options supplied to the initialization routine c09aaf.
6:     icomm100 – Integer arrayCommunication Array
On entry: contains details of the discrete wavelet transform and the problem dimension for the forward transform previously computed by c09ccf.
7:     ifail – IntegerInput/Output
On entry: ifail must be set to 0, -1​ or ​1. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value -1​ 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 argument, the recommended value is 0. When the value -1​ or ​1 is used it is essential to test the value of ifail on exit.
On exit: ifail=0 unless the routine detects an error or a warning has been flagged (see Section 6).

6
Error Indicators and Warnings

If on entry ifail=0 or -1, explanatory error messages are output on the current error message unit (as defined by x04aaf).
Errors or warnings detected by the routine:
ifail=1
On entry, nwlinv=value.
Constraint: nwlinv1.
On entry, nwlinv is larger than the number of levels computed by the preceding call to c09ccf: nwlinv=value, expected =value.
ifail=2
On entry, lenc is set too small: lenc=value.
Constraint: lencvalue.
ifail=4
On entry, n is inconsistent with the value passed to the initialization routine: n=value, n should be value.
ifail=6
Either the initialization routine has not been called first or array icomm has been corrupted.
Either the initialization routine was called with wtrans='S' or array icomm has been corrupted.
ifail=-99
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.
ifail=-399
Your licence key may have expired or may not have been installed correctly.
See Section 3.8 in How to Use the NAG Library and its Documentation for further information.
ifail=-999
Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

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
Parallelism and Performance

c09cdf is not threaded in any implementation.

9
Further Comments

None.

10
Example

See Section 10 in c09ccf.
© The Numerical Algorithms Group Ltd, Oxford, UK. 2017