NAG Library Routine Document

C09FBF

1  Purpose

2  Specification

3  Description

4  References

5  Parameters

1:     $\mathrm{M}$ – INTEGERInput

On entry: the number of rows of each two-dimensional frame.

Constraint: this must be the same as the value M passed to the initialization routine C09ACF.

2:     $\mathrm{N}$ – INTEGERInput

On entry: the number of columns of each two-dimensional frame.

Constraint: this must be the same as the value N passed to the initialization routine C09ACF.

3:     $\mathrm{FR}$ – INTEGERInput

On entry: the number two-dimensional frames.

Constraint: this must be the same as the value FR passed to the initialization routine C09ACF.

4:     $\mathrm{LENC}$ – INTEGERInput

On entry: the dimension of the array C as declared in the (sub)program from which C09FBF is called.

Constraint: $\mathbf{LENC}\ge n_{\mathrm{ct}}$, where $n_{\mathrm{ct}}$ is the total number of wavelet coefficients, as returned by C09ACF.

5:     $\mathrm{C}\left(\mathbf{LENC}\right)$ – REAL (KIND=nag_wp) arrayInput

On entry: the coefficients of the discrete wavelet transform. This will normally be the result of some transformation on the coefficients computed by routine C09FAF.

Note that the coefficients in C may be extracted according to type into three-dimensional arrays using C09FYF, and inserted using C09FZF.

6:     $\mathrm{B}\left(\mathbf{LDB},\mathbf{SDB},\mathbf{FR}\right)$ – REAL (KIND=nag_wp) arrayOutput

On exit: the $m$ by $n$ by $\mathit{fr}$ reconstructed array, $B$, with $B_{ijk}$ stored in $\mathbf{B}\left(i,j,k\right)$. The reconstruction is based on the input wavelet coefficients and the transform options supplied to the initialization routine C09ACF.

7:     $\mathrm{LDB}$ – INTEGERInput

On entry: the first dimension of the array B as declared in the (sub)program from which C09FBF is called.

Constraint: $\mathbf{LDB}\ge \mathbf{M}$.

8:     $\mathrm{SDB}$ – INTEGERInput

On entry: the second dimension of the array B as declared in the (sub)program from which C09FBF is called.

Constraint: $\mathbf{SDB}\ge \mathbf{N}$.

9:     $\mathrm{ICOMM}\left(260\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 C09ACF.

10:   $\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{FR}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{FR}=〈\mathit{\text{value}}〉$, the value of FR on initialization (see C09ACF).

On entry, $\mathbf{M}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{M}=〈\mathit{\text{value}}〉$, the value of M on initialization (see C09ACF).

On entry, $\mathbf{N}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{N}=〈\mathit{\text{value}}〉$, the value of N on initialization (see C09ACF).

$\mathbf{IFAIL}=2$

On entry, $\mathbf{LDB}=〈\mathit{\text{value}}〉$ and $\mathbf{M}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{LDB}\ge \mathbf{M}$.

On entry, $\mathbf{SDB}=〈\mathit{\text{value}}〉$ and $\mathbf{N}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{SDB}\ge \mathbf{N}$.

$\mathbf{IFAIL}=3$

On entry, $\mathbf{LENC}=〈\mathit{\text{value}}〉$ and $n_{\mathrm{ct}}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{LENC}\ge n_{\mathrm{ct}}$, where $n_{\mathrm{ct}}$ is the number of DWT coefficients returned by C09ACF in parameter NWCT.

$\mathbf{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 $\mathbf{WTRANS}=\text{'M'}$.

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