naginterfaces.library.wav.dim3_​sngl_​inv

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

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://www.nag.com/numeric/nl/nagdoc_30/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

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

The reconstructed array, , with stored in . The reconstruction is based on the input wavelet coefficients and the transform options supplied to the initialization function dim3_init().

Raises
NagValueError
(errno )

On entry, .

Constraint: , the value of on initialization (see dim3_init()).

(errno )

On entry, .

Constraint: , the value of on initialization (see dim3_init()).

(errno )

On entry, .

Constraint: , the value of on initialization (see dim3_init()).

(errno )

On entry, and .

Constraint: , where is the number of DWT coefficients returned by dim3_init() in argument .

(errno )

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

(errno )

Either the communication array [‘icomm’] has been corrupted or 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, , dim3_sngl_inv will reconstruct .