NAG Library Routine Document

c09cbf (dim1_sngl_inv)

1
Purpose

c09cbf computes the inverse one-dimensional discrete wavelet transform (DWT) at a single level. The initialization routine c09aaf must be called first to set up the DWT options.

2
Specification

Fortran Interface
Subroutine c09cbf ( lenc, ca, cd, n, y, icomm, ifail)
Integer, Intent (In):: lenc, n, icomm(100)
Integer, Intent (Inout):: ifail
Real (Kind=nag_wp), Intent (In):: ca(lenc), cd(lenc)
Real (Kind=nag_wp), Intent (Out):: y(n)
C Header Interface
#include <nagmk26.h>
void  c09cbf_ (const Integer *lenc, const double ca[], const double cd[], const Integer *n, double y[], const Integer icomm[], Integer *ifail)

3
Description

c09cbf performs the inverse operation of c09caf. That is, given sets of nc approximation coefficients and detail coefficients, computed by c09caf using a DWT as set up by the initialization routine c09aaf, on a real data array of length n, c09cbf will reconstruct the data array yi, for i=1,2,,n, from which the coefficients were derived.

4
References

None.

5
Arguments

1:     lenc – IntegerInput
On entry: the dimension of the arrays ca and cd as declared in the (sub)program from which c09cbf is called.
Constraint: lencnc, where nc is the value returned in nwc by the call to the initialization routine c09aaf.
2:     calenc – Real (Kind=nag_wp) arrayInput
On entry: the nc approximation coefficients, Ca. These will normally be the result of some transformation on the coefficients computed by c09caf.
3:     cdlenc – Real (Kind=nag_wp) arrayInput
On entry: the nc detail coefficients, Cd. These will normally be the result of some transformation on the coefficients computed by c09caf.
4:     n – IntegerInput
On entry: n, the length of the original data array from which the wavelet coefficients were computed by c09caf and the length of the data array y that is to be reconstructed by this routine.
Constraint: This must be the same as the value n passed to the initialization routine c09aaf.
5:     yn – Real (Kind=nag_wp) arrayOutput
On exit: the reconstructed data based on approximation and detail coefficients Ca and Cd and the transform 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 and, possibly, additional information on the previously computed forward transform.
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, array dimension lenc not large enough: lenc=value but must be at least value.
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='M' 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

c09cbf is not threaded in any implementation.

9
Further Comments

None.

10
Example

See Section 10 in c09caf.