Into

Modules

Documentation

classPiiWaveletTransform

#include <PiiWaveletTransform.h>

Discrete wavelet decomposition in two dimensions.

Inherits PiiDefaultOperation

Description

Inputs

inputinput matrix. Any integer or floating-point matrix.

Outputs

approximationapproximation coefficients (the result of low-pass filtering in both dimensions)
horizontalhorizontal details (horizontal high-pass, vertical low-pass)
verticalvertical details (vertical high-pass, horizontal low-pass)
diagonaldiagonal details (high-pass in both dimensions)

Properties

int

The index of the wavelet within the chosen family.

The family of wavelets used in the decomposition.

Public types

enum
{ Haar, Daubechies }

Known wavelet families.

Constructors and destructor

Public member functions

int
void
(
  • int familyMember
)
void
( )

Protected member functions

virtual void

Executes one round of processing.

Property details

  • int familyMember

    [read, write]

    The index of the wavelet within the chosen family.

    This value is ignored for the Haar "family". The operation supports members 1-10 of the Daubechies family. Note that Daubechies 1 is equal to Haar. The default value is 1.

  • WaveletFamily waveletFamily

    [read, write]

    The family of wavelets used in the decomposition.

    The default is Haar.

Enumeration details

  • enum WaveletFamily

    Known wavelet families.

    Families currently known are:

    • Haar - the Haar wavelet. Not actually a family, but equal to the first Daubechies wavelet.

    • Daubechies - Daubechies wavelet family

Function details

  • PiiWaveletTransform

    ()
  • int familyMember

    ()
  • void setFamilyMember

    (
    • int familyMember
    )
  • void setWaveletFamily

    ( )
  • WaveletFamily waveletFamily

    ()
  • virtual void process

    ()
    [protected, virtual]

    Executes one round of processing.

    This function is invoked by the processor if the necessary preconditions for a new processing round are met. This function does all the necessary calculations to create output objects and sends them to output sockets.

    Calls to process(), syncEvent(), and setProperty() are synchronized and cannot occur simultaneously. PiiDefaultOperation ensures this by locking processLock() for reading before calling process().

    Note: With time-consuming operations, one should occasionally check that the operation hasn't been interrupted, i.e. that state() returns Running.

    Exceptions
    PiiExecutionException

    whenever an unrecoverable error occurs during a processing round, the operation is interrupted, or finishes execution due to end of input data.

    Reimplemented from PiiDefaultOperation.

Notes (0)

Add a note

Not a single note added yet. Be the first, add yours.