NAG Library Routine Document

c09faf  (dim3_sngl_fwd)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

1:     $\mathbf{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:     $\mathbf{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:     $\mathbf{fr}$ – IntegerInput

On entry: the number of two-dimensional frames.

Constraint: this must be the same as the value fr passed to the initialization routine c09acf.

4:     $\mathbf{a}\left(\mathbf{lda},\mathbf{sda},\mathbf{fr}\right)$ – Real (Kind=nag_wp) arrayInput

On entry: the $m$ by $n$ by $\mathit{fr}$ three-dimensional input data $A$, where $A_{ijk}$ is stored in $\mathbf{a}\left(i,j,k\right)$.

5:     $\mathbf{lda}$ – IntegerInput

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

Constraint: $\mathbf{lda}\ge \mathbf{m}$.

6:     $\mathbf{sda}$ – IntegerInput

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

Constraint: $\mathbf{sda}\ge \mathbf{n}$.

7:     $\mathbf{lenc}$ – IntegerInput

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

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

8:     $\mathbf{c}\left(\mathbf{lenc}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: the coefficients of the discrete wavelet transform. If you need to access or modify the approximation coefficients or any specific set of detail coefficients then the use of c09fyf or c09fzf is recommended. For completeness the following description provides details of precisely how the coefficients are stored in c but this information should only be required in rare cases.

The $8$ sets of coefficients are stored in the following order: approximation coefficients (LLL) first, followed by $7$ sets of detail coefficients: LLH, LHL, LHH, HLL, HLH, HHL, HHH, where L indicates the low pass filter, and H the high pass filter being applied to, respectively, the columns of length m, the rows of length n and then the frames of length fr. Note that for computational efficiency reasons each set of coefficients is stored in the order $n_{\mathrm{cfr}}\times n_{\mathrm{cm}}\times n_{\mathrm{cn}}$ (see output arguments nwcfr, nwct and nwcn in c09acf). See Section 10 for details of how to access each set of coefficients in order to perform extraction from c following a call to this routine, or insertion into c before a call to the three-dimensional inverse routine c09fbf.

9:     $\mathbf{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.

On exit: contains additional information on the computed transform.

10:   $\mathbf{ifail}$ – IntegerInput/Output

On entry: ifail must be set to $0$, $-1\text{ 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\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 argument, 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{lda}=〈\mathit{\text{value}}〉$ and $\mathbf{m}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{lda}\ge \mathbf{m}$.

On entry, $\mathbf{sda}=〈\mathit{\text{value}}〉$ and $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{sda}\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 argument 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.9 in How to Use the NAG Library and its Documentation for further information.

$\mathbf{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.

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

8

Parallelism and Performance

9

Further Comments

10

Example

10.1

Program Text

Program Text (c09fafe.f90)

10.2

Program Data

Program Data (c09fafe.d)

10.3

Program Results

Program Results (c09fafe.r)