GiciTransform
Class ForwardPyramidal3D

java.lang.Object
  GiciTransform.ForwardPyramidal3D

public class ForwardPyramidal3D
extends java.lang.Object

This class receives a set of parameters from the user to compute a predefined 3d Square (dyadic) Wavelet Transform executing the HyperWaveletTransform class concordingly. Usage example:
construct
setParameters
run

Version:

1.0

Author:

Group on Interactive Coding of Images (GICI)

Field Summary

(package private) float[][][]	imageSamples Image samples (index meaning [z][y][x]).
(package private) boolean	parametersSet To know if parameters are set.
(package private) int[]	WTLevels DWT levels to apply for each dimension.
(package private) int	WTOrder To know the order in which the transform is going to be applied.
(package private) int[]	WTTypes Discrete wavelet transform to be applied at each dimension.
(package private) int	xSize Image width.
(package private) int	ySize Image height.
(package private) int	zSize Number of image components.

Constructor Summary

ForwardPyramidal3D(float[][][] imageSamples)
Constructor, receives the original image samples.

Method Summary

float[][][]	run() Performs the requested 3D Square (dyadic) WT and returns the result image.
void	setParameters(int[] WTTypes, int[] WTLevels) Set the parameters used to apply the discrete wavelet transform, legacy use, WTOrder is going to be set to default values.
void	setParameters(int[] WTTypes, int[] WTLevels, int WTOrder) Set the parameters used to apply the discrete wavelet transform.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

imageSamples

float[][][] imageSamples

Image samples (index meaning [z][y][x]).

zSize

int zSize

Number of image components.

Negative values are not allowed for this field.

ySize

int ySize

Image height.

Negative values are not allowed for this field.

xSize

int xSize

Image width.

Negative values are not allowed for this field.

WTTypes

int[] WTTypes

Discrete wavelet transform to be applied at each dimension.

Only the 3 first elements of the array are going to be taken, the rest is ignored.

• WTTypes[0] X axis
• WTTypes[1] Y axis
• WTTypes[2] Z axis

Valid values are:

• 0 - Nothing
• 1 - Reversible 5/3 DWT
• 2 - Irreversible 9/7 DWT Isorange
• 3 - Irreversible 9/7 DWT Isonorm
• 4 - Integer (reversible) 9/7 M (CCSDS Recommended )

WTLevels

int[] WTLevels

DWT levels to apply for each dimension.

Negative values not allowed. Only the 3 first elements of the array are going to be taken, the rest is ignored.

• WTLevels[0] X axis
• WTLevels[1] Y axis
• WTLevels[2] Z axis

WTOrder

int WTOrder

To know the order in which the transform is going to be applied.

Valid values are:

• 0 - X, Y, Z
• 1 - X, Z, Y
• 2 - Y, X, Z
• 3 - Y, Z, X
• 4 - Z, X, Y
• 5 - Z, Y, X

parametersSet

boolean parametersSet

To know if parameters are set.

True indicates that they are set otherwise false.

Constructor Detail

ForwardPyramidal3D

public ForwardPyramidal3D(float[][][] imageSamples)

Constructor, receives the original image samples.

Parameters:

imageSamples - definition in imageSamples

Method Detail

setParameters

public void setParameters(int[] WTTypes,
                          int[] WTLevels)

Set the parameters used to apply the discrete wavelet transform, legacy use, WTOrder is going to be set to default values.

Parameters:

WTTypes - definition in WTTypes

WTLevels - definition in WTLevels

setParameters

public void setParameters(int[] WTTypes,
                          int[] WTLevels,
                          int WTOrder)

Set the parameters used to apply the discrete wavelet transform.

Parameters:

WTTypes - definition in WTTypes

WTLevels - definition in WTLevels

WTOrder - definition in WTOrder

run

public float[][][] run()
                throws ErrorException

Performs the requested 3D Square (dyadic) WT and returns the result image.

Returns:

the DWT image

Throws:

ErrorException - when parameters are not set, wavelet type is unrecognized or there is an insconsistency in the parameters.