# NAG FL Interfacec09edf (dim2_​multi_​inv)

## 1Purpose

c09edf computes the inverse two-dimensional multi-level discrete wavelet transform (DWT). This routine reconstructs data from (possibly filtered or otherwise manipulated) wavelet transform coefficients calculated by c09ecf from an original input matrix. The initialization routine c09abf must be called first to set up the DWT options.

## 2Specification

Fortran Interface
 Subroutine c09edf ( lenc, c, m, n, b, ldb,
 Integer, Intent (In) :: nwlinv, lenc, m, n, ldb, icomm(180) Integer, Intent (Inout) :: ifail Real (Kind=nag_wp), Intent (In) :: c(lenc) Real (Kind=nag_wp), Intent (Inout) :: b(ldb,n)
#include <nag.h>
 void c09edf_ (const Integer *nwlinv, const Integer *lenc, const double c[], const Integer *m, const Integer *n, double b[], const Integer *ldb, const Integer icomm[], Integer *ifail)
The routine may be called by the names c09edf or nagf_wav_dim2_multi_inv.

## 3Description

c09edf performs the inverse operation of c09ecf. That is, given a set of wavelet coefficients, computed up to level ${n}_{\mathrm{fwd}}$ by c09ecf using a DWT as set up by the initialization routine c09abf, on a real matrix, $A$, c09edf will reconstruct $A$. The reconstructed matrix 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 matrix 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 c09ecf. This results in a partial reconstruction.
None.

## 5Arguments

1: $\mathbf{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 ${n}_{\mathrm{fwd}}$, which has the value of argument nwl as used in the computation of the wavelet coefficients using c09ecf. The data will be reconstructed to level $\left({\mathbf{nwl}}-{\mathbf{nwlinv}}\right)$, where level $0$ is the original input dataset provided to c09ecf.
Constraint: $1\le {\mathbf{nwlinv}}\le {\mathbf{nwl}}$, where nwl is the value used in a preceding call to c09ecf.
2: $\mathbf{lenc}$Integer Input
On entry: the dimension of the array c as declared in the (sub)program from which c09edf is called.
Constraint: ${\mathbf{lenc}}\ge {n}_{\mathrm{ct}}$, where ${n}_{\mathrm{ct}}$ is the total number of coefficients that correspond to a transform with nwlinv levels and is unchanged from the preceding call to c09ecf.
3: $\mathbf{c}\left({\mathbf{lenc}}\right)$Real (Kind=nag_wp) array Input
On entry: the coefficients of a multi-level wavelet transform of the original matrix, $A$, which may have been filtered or otherwise manipulated.
Let $q\left(\mathit{i}\right)$ be the number of coefficients (of each type) at level $\mathit{i}$, for $\mathit{i}={n}_{\mathrm{fwd}},{n}_{\mathrm{fwd}}-1,\dots ,1$. Then, setting ${k}_{1}=q\left({n}_{\mathrm{fwd}}\right)$ and ${k}_{j+1}={k}_{j}+q\left({n}_{\mathrm{fwd}}-⌈j/3⌉+1\right)$, for $j=1,2,\dots ,3{n}_{\mathrm{fwd}}$, the coefficients are stored in c as follows:
${\mathbf{c}}\left(\mathit{i}\right)$, for $\mathit{i}=1,2,\dots ,{k}_{1}$
Contains the level ${n}_{\mathrm{fwd}}$ approximation coefficients, ${a}_{{n}_{\mathrm{fwd}}}$.
${\mathbf{c}}\left(\mathit{i}\right)$, for $\mathit{i}={k}_{j}+1,\dots ,{k}_{j+1}$
Contains the level ${n}_{\mathrm{fwd}}-⌈j/3⌉+1$ vertical, horizontal and diagonal coefficients. These are:
• vertical coefficients if ;
• horizontal coefficients if ;
• diagonal coefficients if ,
for $j=1,\dots ,3{n}_{\mathrm{fwd}}$.
Note that the coefficients in c may be extracted according to level and type into two-dimensional arrays using c09eyf, and inserted using c09ezf.
4: $\mathbf{m}$Integer Input
On entry: the number of elements, $m$, in the first dimension of the reconstructed matrix $B$. For a full reconstruction of nwl levels, where nwl is as supplied to c09ecf, this must be the same as argument m used in the call to c09ecf. For a partial reconstruction of ${\mathbf{nwlinv}}<{\mathbf{nwl}}$ levels, this must be equal to ${\mathbf{dwtlvm}}\left({\mathbf{nwlinv}}+1\right)$, as returned from c09ecf.
5: $\mathbf{n}$Integer Input
On entry: the number of elements, $n$, in the second dimension of the reconstructed matrix $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 the call to c09ecf. For a partial reconstruction of ${\mathbf{nwlinv}}<{\mathbf{nwl}}$, this must be equal to ${\mathbf{dwtlvn}}\left({\mathbf{nwlinv}}+1\right)$, as returned from c09ecf.
6: $\mathbf{b}\left({\mathbf{ldb}},{\mathbf{n}}\right)$Real (Kind=nag_wp) array Output
On exit: the $m$ by $n$ reconstructed matrix, $B$, based on the input multi-level wavelet transform coefficients and the transform options supplied to the initialization routine c09abf.
7: $\mathbf{ldb}$Integer Input
On entry: the first dimension of the array b as declared in the (sub)program from which c09edf is called.
Constraint: ${\mathbf{ldb}}\ge {\mathbf{m}}$.
8: $\mathbf{icomm}\left(180\right)$Integer array Communication Array
On entry: contains details of the discrete wavelet transform and the problem dimension as setup in the call to the initialization routine c09abf.
9: $\mathbf{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 $-\mathbf{1}$ 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).

## 6Error Indicators and Warnings

If on entry ${\mathbf{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:
${\mathbf{ifail}}=1$
On entry, ${\mathbf{nwlinv}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{nwlinv}}\ge 1$.
On entry, ${\mathbf{nwlinv}}=〈\mathit{\text{value}}〉$ and ${n}_{\mathrm{fwd}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{nwlinv}}\le {n}_{\mathrm{fwd}}$.
${\mathbf{ifail}}=2$
On entry, ${\mathbf{ldb}}=〈\mathit{\text{value}}〉$ and ${\mathbf{m}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{ldb}}\ge {\mathbf{m}}$.
${\mathbf{ifail}}=3$
On entry, ${\mathbf{lenc}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{lenc}}\ge 〈\mathit{\text{value}}〉$, the total number of coefficients generated by the preceding call to c09ecf.
${\mathbf{ifail}}=4$
On entry, ${\mathbf{m}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{m}}\ge 〈\mathit{\text{value}}〉$, the number of coefficients in the first dimension at the required level of reconstruction.
On entry, ${\mathbf{n}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{n}}\ge 〈\mathit{\text{value}}〉$, the number of coefficients in the second dimension at the required level of reconstruction.
${\mathbf{ifail}}=6$
Either the initialization routine has not been called first or icomm has been corrupted.
Either the initialization routine was called with ${\mathbf{wtrans}}=\text{'S'}$ or icomm has been corrupted.
${\mathbf{ifail}}=-99$
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
${\mathbf{ifail}}=-399$
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.
${\mathbf{ifail}}=-999$
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

## 7Accuracy

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.

## 8Parallelism and Performance

c09edf is not threaded in any implementation.