NAG FL Interface
c09cdf (dim1_​multi_​inv)

Settings help

FL Name Style:

FL Specification Language:

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 <nag.h>
void  c09cdf_ (const Integer *nwlinv, const Integer *lenc, const double c[], const Integer *n, double y[], const Integer icomm[], Integer *ifail)
The routine may be called by the names c09cdf or nagf_wav_dim1_multi_inv.

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


5 Arguments

1: nwlinv Integer Input
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 Integer Input
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: c(lenc) Real (Kind=nag_wp) array Input
On entry: the coefficients of a multi-level wavelet transform of the dataset.
Let q(i) be the number of coefficients (of each type) at level i, for i=nfwd,nfwd-1,,1. Then, setting k1=q(nfwd) and kj+1=kj+q(nfwd-j+1), for j=1,2,,nfwd, the coefficients are stored in c as follows:
c(i), for i=1,2,,k1
Contains the level nfwd approximation coefficients, anfwd.
c(i), for i=k1+1,,k2
Contains the level nfwd detail coefficients dnfwd.
c(i), for i=kj+1,,kj+1
Contains the level nfwd-j+1 detail coefficients, for j=2,3,,nfwd.
The values q(i), 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 Integer Input
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 dwtlev(nwlinv+2), as returned from c09ccf.
5: y(n) Real (Kind=nag_wp) array Output
On exit: the dataset reconstructed from the multi-level wavelet transform coefficients and the transformation options supplied to the initialization routine c09aaf.
6: icomm(100) Integer array Communication Array
On entry: contains details of the discrete wavelet transform and the problem dimension for the forward transform previously computed by c09ccf.
7: ifail Integer Input/Output
On entry: ifail must be set to 0, −1 or 1 to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of 0 causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of −1 means that an error message is printed while a value of 1 means that it is not.
If halting is not appropriate, the value −1 or 1 is recommended. If message printing is undesirable, then the value 1 is recommended. Otherwise, the value 0 is recommended. 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:
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.
On entry, lenc is set too small: lenc=value.
Constraint: lencvalue.
On entry, n is inconsistent with the value passed to the initialization routine: n=value, n should be value.
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.
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface 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

Background information to multithreading can be found in the Multithreading documentation.
c09cdf is not threaded in any implementation.

9 Further Comments


10 Example

See c09ccf.