NAG Library Routine Document

c09fdf (dim3_mxolap_multi_inv)

1
Purpose

c09fdf computes the inverse three-dimensional multi-level discrete wavelet transform (IDWT). This routine reconstructs data from (possibly filtered or otherwise manipulated) wavelet transform coefficients calculated by c09fcf from an original input array. The initialization routine c09acf must be called first to set up the IDWT options.

2
Specification

Fortran Interface
Subroutine c09fdf ( nwlinv, lenc, c, m, n, fr, b, ldb, sdb, icomm, ifail)
Integer, Intent (In):: nwlinv, lenc, m, n, fr, ldb, sdb, icomm(260)
Integer, Intent (Inout):: ifail
Real (Kind=nag_wp), Intent (In):: c(lenc)
Real (Kind=nag_wp), Intent (Inout):: b(ldb,sdb,fr)
C Header Interface
#include <nagmk26.h>
void  c09fdf_ (const Integer *nwlinv, const Integer *lenc, const double c[], const Integer *m, const Integer *n, const Integer *fr, double b[], const Integer *ldb, const Integer *sdb, const Integer icomm[], Integer *ifail)

3
Description

c09fdf performs the inverse operation of c09fcf. That is, given a set of wavelet coefficients, computed up to level nfwd by c09fcf using a DWT as set up by the initialization routine c09acf, on a real three-dimensional array, A, c09fdf will reconstruct A. The reconstructed array is referred to as B in the following since it will not be identical to A when the DWT coefficients have been filtered or otherwise manipulated prior to reconstruction. If the original input array 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 c09fcf. This results in a partial reconstruction.

4
References

Wang Y, Che X and Ma S (2012) Nonlinear filtering based on 3D wavelet transform for MRI denoising URASIP Journal on Advances in Signal Processing 2012:40

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 c09fcf. The data will be reconstructed to level nwl-nwlinv, where level 0 is the original input dataset provided to c09fcf.
Constraint: 1nwlinvnwl, where nwl is the value used in a preceding call to c09fcf.
2:     lenc – IntegerInput
On entry: the dimension of the array c as declared in the (sub)program from which c09fdf is called.
Constraint: lencnct, where nct is the total number of wavelet coefficients that correspond to a transform with nwlinv levels.
3:     clenc – Real (Kind=nag_wp) arrayInput
On entry: the coefficients of the multi-level discrete wavelet transform. This will normally be the result of some transformation on the coefficients computed by routine c09fcf.
Note that the coefficients in c may be extracted according to level and type into three-dimensional arrays using c09fyf, and inserted using c09fzf.
4:     m – IntegerInput
On entry: the number of elements, m, in the first dimension of the reconstructed array B. For a full reconstruction of nwl levels, where nwl is as supplied to c09fcf, this must be the same as argument m used in a preceding call to c09fcf. For a partial reconstruction of nwlinv<nwl levels, this must be equal to dwtlvmnwlinv+1, as returned from c09fcf
5:     n – IntegerInput
On entry: the number of elements, n, in the second dimension of the reconstructed array B. For a full reconstruction of nwl, levels, where nwl is as supplied to c09fcf, this must be the same as argument n used in a preceding call to c09fcf. For a partial reconstruction of nwlinv<nwl levels, this must be equal to dwtlvnnwlinv+1, as returned from c09fcf.
6:     fr – IntegerInput
On entry: the number of elements, fr, in the third dimension of the reconstructed array B. For a full reconstruction of nwl levels, where nwl is as supplied to c09fcf, this must be the same as argument fr used in a preceding call to c09fcf. For a partial reconstruction of nwlinv<nwl levels, this must be equal to dwtlvfrnwlinv+1, as returned from c09fcf.
7:     bldbsdbfr – Real (Kind=nag_wp) arrayOutput
On exit: the m by n by fr reconstructed array, B, with Bijk stored in bijk. The reconstruction is based on the input multi-level wavelet transform coefficients and the transform options supplied to the initialization routine c09acf.
8:     ldb – IntegerInput
On entry: the first dimension of the array b as declared in the (sub)program from which c09fdf is called.
Constraint: ldbm.
9:     sdb – IntegerInput
On entry: the second dimension of the array b as declared in the (sub)program from which c09fdf is called.
Constraint: sdbn.
10:   icomm260 – 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 c09acf.
11:   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=value and nwl=value where nwl is as used in the computation of the wavelet coefficients by a call to c09fcf.
Constraint: nwlinvnwl as used in the call to c09fcf.
ifail=2
On entry, ldb=value and m=value.
Constraint: ldbm.
On entry, sdb=value and n=value.
Constraint: sdbn.
ifail=3
On entry, lenc=value.
Constraint: lencvalue, the number of wavelet coefficients required for a transform operating on nwlinv levels. If nwlinv=nwlmax, the maximum number of levels as returned by the initial call to c09acf, lenc must be at least nct, the value returned in nwct by the same call to c09acf.
ifail=4
On entry, fr=value.
Constraint: frvalue, the number of coefficients in the third dimension at the required level of reconstruction.
On entry, m=value.
Constraint: mvalue, the number of coefficients in the first dimension at the required level of reconstruction.
On entry, n=value.
Constraint: nvalue, the number of coefficients in the second dimension at the required level of reconstruction.
ifail=6
Either the communication array icomm has been corrupted or there has not been a prior call to the initialization routine c09acf.
The initialization routine was called with wtrans='S'.
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

c09fdf is not threaded in any implementation.

9
Further Comments

None.

10
Example

See Section 10 in c09fcf.