naginterfaces.library.wav.dim3_​coeff_​ext

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

dim3_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 dim3_sngl_fwd() (single level three-dimensional DWT) or dim3_multi_fwd() (multi-level three-dimensional DWT).

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

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

Parameters

ilevint

The level at which coefficients are to be extracted.

If $ilev=0$, it is assumed that the coefficient array $c$ was produced by a preceding call to the single level function dim3_sngl_fwd().

If $ilev>0$, it is assumed that the coefficient array $c$ was produced by a preceding call to the multi-level function dim3_multi_fwd().

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, rows and frames of $A$ (LLL). After a call to the multi-level transform function dim3_multi_fwd() (which implies that $ilev>0$) the approximation coefficients are available only for $ilev=\text{nwl}$, where $\text{nwl}$ is the value used in a preceding call to dim3_multi_fwd().

$cindex=1$

The detail coefficients produced by applying the low pass filter over columns and rows of $A$ and the high pass filter over frames (LLH).

$cindex=2$

The detail coefficients produced by applying the low pass filter over columns, high pass filter over rows and low pass filter over frames of $A$ (LHL).

$cindex=3$

The detail coefficients produced by applying the low pass filter over columns of $A$ and high pass filter over rows and frames (LHH).

$cindex=4$

The detail coefficients produced by applying the high pass filter over columns of $A$ and low pass filter over rows and frames (HLL).

$cindex=5$

The detail coefficients produced by applying the high pass filter over columns, low pass filter over rows and high pass filter over frames of $A$ (HLH).

$cindex=6$

The detail coefficients produced by applying the high pass filter over columns and rows of $A$ and the low pass filter over frames (HHL).

$cindex=7$

The detail coefficients produced by applying the high pass filter over columns, rows and frames of $A$ (HHH).

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

DWT coefficients, as computed by dim3_sngl_fwd() or dim3_multi_fwd().

commdict, communication object, modified in place

Communication structure.

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

Returns

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

The requested coefficients.

If the DWT coefficients were computed by dim3_sngl_fwd() then

if $cindex=0$, the approximation coefficients are stored in $d[i-1,\text{j}-1,\text{k}-1]$, for $\text{k}=1,2,\dots ,n_{\text{cfr}}$, for $\text{j}=1,2,\dots ,n_{\text{cn}}$, for $\text{i}=1,2,\dots ,n_{\text{cm}}$;

if $1\le cindex\le 7$, the detail coefficients, as indicated by $cindex$, are stored in $d[i-1,\text{j}-1,\text{k}-1]$, for $\text{k}=1,2,\dots ,n_{\text{cfr}}$, for $\text{j}=1,2,\dots ,n_{\text{cn}}$, for $\text{i}=1,2,\dots ,n_{\text{cm}}$.

If the DWT coefficients were computed by dim3_multi_fwd() then

if $cindex=0$ and $ilev=\text{nwl}$, the approximation coefficients are stored in $d[i-1,\text{j}-1,\text{k}-1]$, for $\text{k}=1,2,\dots ,n_{\text{cfr}}$, for $\text{j}=1,2,\dots ,n_{\text{cn}}$, for $\text{i}=1,2,\dots ,n_{\text{cm}}$;

if $1\le cindex\le 7$, the detail coefficients, as indicated by $cindex$, for level $ilev$ are stored in $d[i-1,\text{j}-1,\text{k}-1]$, for $\text{k}=1,2,\dots ,n_{\text{cfr}}$, 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=0$ following a call to the single level function dim3_sngl_fwd().

(errno $1$)

On entry, $ilev=⟨value⟩$.

Constraint: $ilev>0$ following a call to the multi-level function dim3_multi_fwd().

(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 dim3_multi_fwd().

(errno $2$)

On entry, $cindex=⟨value⟩$.

Constraint: $cindex\ge 0$.

(errno $2$)

On entry, $cindex=⟨value⟩$.

Constraint: $cindex\le 7$.

(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 the preceding call to dim3_sngl_fwd().

(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 the preceding call to dim3_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 dim3_multi_fwd().

(errno $6$)

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

Notes

dim3_coeff_ext is intended to be used after a call to either dim3_sngl_fwd() (single level three-dimensional DWT) or dim3_multi_fwd() (multi-level three-dimensional DWT), either of which must be preceded by a call to dim3_init() (three-dimensional wavelet filter initialization). Given an initial three-dimensional data set $A$, a prior call to dim3_sngl_fwd() or dim3_multi_fwd() computes the approximation coefficients (at the highest requested level in the case of dim3_multi_fwd()) and seven sets of detail coefficients (at all levels in the case of dim3_multi_fwd()) and stores these in compact form in a one-dimensional array $c$. dim3_coeff_ext can then extract either the approximation coefficients or one of the sets of detail coefficients (at one of the levels following dim3_multi_fwd()) into a three-dimensional data set stored in $d$.

If a multi-level DWT was performed by a prior call to dim3_multi_fwd() then the dimensions of the three-dimensional data stored in $d$ depend on the level extracted and are available from the arrays $\text{dwtlvm}$, $\text{dwtlvn}$ and $\text{dwtlvfr}$ as returned by dim3_multi_fwd() which contain the first, second and third dimensions respectively.

If a single level DWT was performed by a prior call to dim3_sngl_fwd() then the dimensions of the three-dimensional data stored in $d$ can be determined from $\text{nwct}$, $\text{nwcn}$ and $\text{nwcfr}$ as returned by the setup function dim3_init().

See the C09 Introduction for a discussion of the three-dimensional DWT.