naginterfaces.library.wav.dim2_​coeff_​ext

naginterfaces.library.wav.dim2_coeff_ext(ilev, cindex, c, comm)

dim2_coeff_ext extracts a selected set of discrete wavelet transform (DWT) coefficients from the full set of coefficients stored in compact form, as computed by dim2_multi_fwd() (two-dimensional DWT).

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

https://www.nag.com/numeric/nl/nagdoc_30/flhtml/c09/c09eyf.html

Parameters

ilevint

The level at which coefficients are to be extracted.

cindexint

Identifies which coefficients to extract. The coefficients are identified as follows:

$cindex=0$

The approximation coefficients, produced by application of the low pass filter over columns and rows of the original matrix (LL). The approximation coefficients are available only for $ilev=\text{nwl}$, where $\text{nwl}$ is the value used in a preceding call to dim2_multi_fwd().

$cindex=1$

The vertical detail coefficients produced by applying the low pass filter over columns of the original matrix and the high pass filter over rows (LH).

$cindex=2$

The horizontal detail coefficients produced by applying the high pass filter over columns of the original matrix and the low pass filter over rows (HL).

$cindex=3$

The diagonal detail coefficients produced by applying the high pass filter over columns and rows of the original matrix (HH).

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

DWT coefficients, as computed by a preceding call to dim2_multi_fwd().

commdict, communication object, modified in place

Communication structure.

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

Returns

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

The requested coefficients.

If $ilev=\text{nwl}$ (as used in dim2_multi_fwd()) and $cindex=0$, the $n_{\text{cm}}\times n_{\text{cn}}$ approximation coefficients $a_{ij}$ are stored in $d[i-1,\text{j}-1]$, for $\text{j}=1,2,\dots ,n_{\text{cn}}$, for $\text{i}=1,2,\dots ,n_{\text{cm}}$.

Otherwise the $n_{\text{cm}}\times n_{\text{cn}}$ level $ilev$ detail coefficients (of type specified by $cindex$) $d_{ij}$ are stored in $d[i-1,\text{j}-1]$, for $\text{j}=1,2,\dots ,n_{\text{cn}}$, for $\text{i}=1,2,\dots ,n_{\text{cm}}$.

Raises

NagValueError

(errno $1$)

On entry, $ilev=⟨value⟩$.

Constraint: $ilev\ge 1$.

(errno $1$)

On entry, $ilev=⟨value⟩$ and $\text{nwl}=⟨value⟩$.

Constraint: $ilev\le \text{nwl}$, where $\text{nwl}$ is the number of levels used in the call to dim2_multi_fwd().

(errno $2$)

On entry, $cindex=⟨value⟩$.

Constraint: $cindex\ge 0$.

(errno $2$)

On entry, $cindex=⟨value⟩$.

Constraint: $cindex\le 3$.

(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 computed in a previous call to dim2_multi_fwd().

(errno $5$)

On entry, $ilev=⟨value⟩$ and $\text{nwl}=⟨value⟩$, but $cindex=0$.

Constraint: $cindex>0$ when $ilev<\text{nwl}$ in the preceding call to dim2_multi_fwd().

(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{‘S'}$ or $comm$[‘icomm’] has been corrupted.

Notes

dim2_coeff_ext is intended to be used after a call to dim2_multi_fwd() (two-dimensional DWT), which in turn should be preceded by a call to dim2_init() (two-dimensional wavelet filter initialization). Given an initial two-dimensional data set $A$, a prior call to dim2_multi_fwd() computes the approximation coefficients (at the highest requested level) and three sets of detail coefficients at all levels and stores these in compact form in a one-dimensional array $c$. dim2_coeff_ext can then extract either the approximation coefficients or one of the sets of detail coefficients at one of the levels into a matrix $D$. The dimensions of $D$ depend on the level extracted and are available from the arrays $\text{dwtlvm}$ and $\text{dwtlvn}$ as returned by dim2_multi_fwd() which contain the first and second dimensions respectively. See the C09 Introduction for a discussion of the two-dimensional DWT.