NAG Library Routine Document

C09EDF

1  Purpose

2  Specification

3  Description

4  References

5  Parameters

1:     $\mathrm{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 $n_{\mathrm{fwd}}$, which has the value of parameter 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:     $\mathrm{LENC}$ – INTEGERInput

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:     $\mathrm{C}\left(\mathbf{LENC}\right)$ – REAL (KIND=nag_wp) arrayInput

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 ,3n_{\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 $j\mathrm{ mod }3=1$;
• horizontal coefficients if $j\mathrm{ mod }3=2$;
• diagonal coefficients if $j\mathrm{ mod }3=0$,

for $j=1,\dots ,3n_{\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:     $\mathrm{M}$ – INTEGERInput

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 parameter 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:     $\mathrm{N}$ – INTEGERInput

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 parameter 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:     $\mathrm{B}\left(\mathbf{LDB},\mathbf{N}\right)$ – REAL (KIND=nag_wp) arrayOutput

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:     $\mathrm{LDB}$ – INTEGERInput

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:     $\mathrm{ICOMM}\left(180\right)$ – 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 C09ABF.

9:     $\mathrm{IFAIL}$ – INTEGERInput/Output

On entry: IFAIL must be set to $0$, $-1\text{ or }1$. If you are unfamiliar with this parameter you should refer to Section 3.3 in the Essential Introduction for details.

For environments where it might be inappropriate to halt program execution when an error is detected, the value $-1\text{ 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 parameter, the recommended value is $0$. When the value $-\mathbf{1}\text{ 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).

6  Error Indicators and Warnings

$\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$

An unexpected error has been triggered by this routine. Please contact NAG.

See Section 3.8 in the Essential Introduction for further information.

$\mathbf{IFAIL}=-399$

Your licence key may have expired or may not have been installed correctly.

See Section 3.7 in the Essential Introduction for further information.

$\mathbf{IFAIL}=-999$

Dynamic memory allocation failed.

See Section 3.6 in the Essential Introduction for further information.

7  Accuracy

8  Parallelism and Performance

9  Further Comments

10  Example