naginterfaces.library.wav.dim2_​sngl_​fwd

naginterfaces.library.wav.dim2_sngl_fwd(a, comm)

dim2_sngl_fwd computes the two-dimensional discrete wavelet transform (DWT) at a single level. The initialization function dim2_init() must be called first to set up the DWT options.

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

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

Parameters

afloat, array-like, shape $(m,n)$

The $m\times n$ data matrix $A$.

commdict, communication object, modified in place

Communication structure.

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

Returns

cafloat, ndarray, shape $({\text{n}}_{\text{cm}},{\text{n}}_{\text{cn}})$

Contains the $n_{\text{cm}}\times n_{\text{cn}}$ matrix of approximation coefficients, $C_a$.

chfloat, ndarray, shape $({\text{n}}_{\text{cm}},{\text{n}}_{\text{cn}})$

Contains the $n_{\text{cm}}\times n_{\text{cn}}$ matrix of horizontal coefficients, $C_h$.

cvfloat, ndarray, shape $({\text{n}}_{\text{cm}},{\text{n}}_{\text{cn}})$

Contains the $n_{\text{cm}}\times n_{\text{cn}}$ matrix of vertical coefficients, $C_v$.

cdfloat, ndarray, shape $({\text{n}}_{\text{cm}},{\text{n}}_{\text{cn}})$

Contains the $n_{\text{cm}}\times n_{\text{cn}}$ matrix of diagonal coefficients, $C_d$.

Raises

NagValueError

(errno $1$)

On entry, $n=⟨value⟩$.

Constraint: $n=⟨value⟩$, the value of $\text{n}$ on initialization (see dim2_init()).

(errno $1$)

On entry, $m=⟨value⟩$.

Constraint: $m=⟨value⟩$, the value of $\text{m}$ on initialization (see dim2_init()).

(errno $6$)

Either the initialization function has not been called first or $comm$[‘icomm’] has been corrupted.

(errno $6$)

Either the initialization function was called with $wtrans=\text{‘M'}$ or $comm$[‘icomm’] has been corrupted.

Notes

dim2_sngl_fwd computes the two-dimensional DWT of a given input data array, considered as a matrix $A$, at a single level. For a chosen wavelet filter pair, the output coefficients are obtained by applying convolution and downsampling by two to the input, $A$, first over columns and then to the result over rows. The matrix of approximation (or smooth) coefficients, $C_a$, is produced by the low pass filter over columns and rows; the matrix of horizontal coefficients, $C_h$, is produced by the high pass filter over columns and the low pass filter over rows; the matrix of vertical coefficients, $C_v$, is produced by the low pass filter over columns and the high pass filter over rows; and the matrix of diagonal coefficients, $C_d$, is produced by the high pass filter over columns and rows. To reduce distortion effects at the ends of the data array, several end extension methods are commonly used. Those provided are: periodic or circular convolution end extension, half-point symmetric end extension, whole-point symmetric end extension and zero end extension. The total number, $n_{\text{ct}}$, of coefficients computed for $C_a$, $C_h$, $C_v$, and $C_d$ together and the number of columns of each coefficients matrix, $n_{\text{cn}}$, are returned by the initialization function dim2_init(). These values can be used to calculate the number of rows of each coefficients matrix, $n_{\text{cm}}$, using the formula $n_{\text{cm}}=n_{\text{ct}}/\left(4n_{\text{cn}}\right)$.

References

Daubechies, I, 1992, Ten Lectures on Wavelets, SIAM, Philadelphia