naginterfaces.library.wav.dim3_​sngl_​inv

naginterfaces.library.wav.dim3_sngl_inv(m, n, fr, c, comm)

dim3_sngl_inv computes the three-dimensional inverse discrete wavelet transform (IDWT) at a single level. The initialization function dim3_init() must be called first to set up the DWT options.

For full information please refer to the NAG Library document for c09fb

https://support.nag.com/numeric/nl/nagdoc_30.2/flhtml/c09/c09fbf.html

Parameters

mint

The number of rows of each two-dimensional frame.

nint

The number of columns of each two-dimensional frame.

frint

The number two-dimensional frames.

cfloat, array-like, shape $\left(\text{lenc}\right)$

The coefficients of the discrete wavelet transform. This will normally be the result of some transformation on the coefficients computed by function dim3_sngl_fwd().

Note that the coefficients in $c$ may be extracted according to type into three-dimensional arrays using dim3_coeff_ext(), and inserted using dim3_coeff_ins().

commdict, communication object

Communication structure.

This argument must have been initialized by a prior call to dim3_init().

Returns

bfloat, ndarray, shape $(m,n,fr)$

The $m\times n\times \text{fr}$ reconstructed array, $B$, with $B_{ijk}$ stored in $b[i-1,j-1,k-1]$. The reconstruction is based on the input wavelet coefficients and the transform options supplied to the initialization function dim3_init().

Raises

NagValueError

(errno $1$)

On entry, $n=⟨value⟩$.

Constraint: $n=⟨value⟩$, the value of $n$ on initialization (see dim3_init()).

(errno $1$)

On entry, $m=⟨value⟩$.

Constraint: $m=⟨value⟩$, the value of $m$ on initialization (see dim3_init()).

(errno $1$)

On entry, $fr=⟨value⟩$.

Constraint: $fr=⟨value⟩$, the value of $fr$ on initialization (see dim3_init()).

(errno $3$)

On entry, $\text{lenc}=⟨value⟩$ and $n_{\text{ct}}=⟨value⟩$.

Constraint: $\text{lenc}\ge n_{\text{ct}}$, where $n_{\text{ct}}$ is the number of DWT coefficients returned by dim3_init() in argument $\text{nwct}$.

(errno $6$)

Either the communication array $comm$[‘icomm’] has been corrupted or there has not been a prior call to the initialization function dim3_init().

(errno $6$)

Either the communication array $comm$[‘icomm’] has been corrupted or $wtrans=\text{‘M'}$ was used in the prior call to the initialization function dim3_init().

Notes

dim3_sngl_inv performs the inverse operation of function dim3_sngl_fwd(). That is, given sets of wavelet coefficients computed by function dim3_sngl_fwd() using a DWT as set up by the initialization function dim3_init(), on a real data array, $B$, dim3_sngl_inv will reconstruct $B$.