jj2000.j2k.wavelet.analysis
Class ForwardWT

java.lang.Object
  |
  +--jj2000.j2k.image.ImgDataAdapter
        |
        +--jj2000.j2k.wavelet.analysis.ForwardWT

All Implemented Interfaces:

CBlkWTDataSrc, ForwWT, ForwWTDataProps, ImgData, WaveletTransform

Direct Known Subclasses:

ForwWTFull

public abstract class ForwardWT

extends ImgDataAdapter

implements ForwWT, CBlkWTDataSrc

This abstract class represents the forward wavelet transform functional block. The functional block may actually be comprised of several classes linked together, but a subclass of this abstract class is the one that is returned as the functional block that performs the forward wavelet transform.

This class assumes that data is transferred in code-blocks, as defined by the 'CBlkWTDataSrc' interface. The internal calculation of the wavelet transform may be done differently but a buffering class should convert to that type of transfer.

Field Summary

static char	OPT_PREFIX The prefix for wavelet transform options: 'W'
private static java.lang.String[][]	pinfo The list of parameters that is accepted for wavelet transform.
static int	WT_DECOMP_DYADIC ID for the dyadic wavelet tree decomposition (also called "Mallat" in JPEG 2000): 0x00.

Fields inherited from class jj2000.j2k.image.ImgDataAdapter

imgdatasrc, tIdx

Fields inherited from interface jj2000.j2k.wavelet.WaveletTransform

WT_IMPL_FULL, WT_IMPL_LINE

Constructor Summary

protected

ForwardWT(ImgData src) Initializes this object for the specified number of tiles 'nt' and components 'nc'.

Method Summary

static ForwardWT	createInstance(BlkImgDataSrc src, ParameterList pl, EncoderSpecs encSpec) Creates a ForwardWT object with the specified filters, and with other options specified in the parameter list 'pl'.
static java.lang.String[][]	getParameterInfo() Returns the parameters that are used in this class and implementing classes.

Methods inherited from class jj2000.j2k.image.ImgDataAdapter

getCompImgHeight, getCompImgWidth, getCompSubsX, getCompSubsY, getCompULX, getCompULY, getImgHeight, getImgULX, getImgULY, getImgWidth, getNomRangeBits, getNomTileHeight, getNomTileWidth, getNumComps, getNumTiles, getNumTiles, getTile, getTileCompHeight, getTileCompWidth, getTileHeight, getTileIdx, getTilePartULX, getTilePartULY, getTileWidth, nextTile, setTile

Methods inherited from class java.lang.Object

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

Methods inherited from interface jj2000.j2k.wavelet.analysis.ForwWT

getDecomp, getDecompLevels, getHorAnWaveletFilters, getVertAnWaveletFilters

Methods inherited from interface jj2000.j2k.wavelet.WaveletTransform

getImplementationType, isReversible

Methods inherited from interface jj2000.j2k.image.ImgData

getCompImgHeight, getCompImgWidth, getCompSubsX, getCompSubsY, getCompULX, getCompULY, getImgHeight, getImgULX, getImgULY, getImgWidth, getNomRangeBits, getNomTileHeight, getNomTileWidth, getNumComps, getNumTiles, getNumTiles, getTile, getTileCompHeight, getTileCompWidth, getTileHeight, getTileIdx, getTilePartULX, getTilePartULY, getTileWidth, nextTile, setTile

Methods inherited from interface jj2000.j2k.wavelet.analysis.ForwWTDataProps

getAnSubbandTree, getCbULX, getCbULY, isReversible

Methods inherited from interface jj2000.j2k.wavelet.analysis.CBlkWTDataSrc

getDataType, getFixedPoint, getNextCodeBlock, getNextInternCodeBlock

Field Detail

WT_DECOMP_DYADIC

public static final int WT_DECOMP_DYADIC

ID for the dyadic wavelet tree decomposition (also called "Mallat" in JPEG 2000): 0x00.

See Also:

Constant Field Values

OPT_PREFIX

public static final char OPT_PREFIX

The prefix for wavelet transform options: 'W'

See Also:

Constant Field Values

pinfo

private static final java.lang.String[][] pinfo

The list of parameters that is accepted for wavelet transform. Options for the wavelet transform start with 'W'.

Constructor Detail

ForwardWT

protected ForwardWT(ImgData src)

Initializes this object for the specified number of tiles 'nt' and components 'nc'.

Parameters:

src - The source of ImgData

Method Detail

getParameterInfo

public static java.lang.String[][] getParameterInfo()

Returns the parameters that are used in this class and implementing classes. It returns a 2D String array. Each of the 1D arrays is for a different option, and they have 3 elements. The first element is the option name, the second one is the synopsis and the third one is a long description of what the parameter is. The synopsis or description may be 'null', in which case it is assumed that there is no synopsis or description of the option, respectively. Null may be returned if no options are supported.

Returns:

the options name, their synopsis and their explanation, or null if no options are supported.

createInstance

public static ForwardWT createInstance(BlkImgDataSrc src,
                                       ParameterList pl,
                                       EncoderSpecs encSpec)

Creates a ForwardWT object with the specified filters, and with other options specified in the parameter list 'pl'.

Parameters:

src - The source of data to be transformed

pl - The parameter list (or options).

Returns:

A new ForwardWT object with the specified filters and options from 'pl'.

Throws:

java.lang.IllegalArgumentException - If mandatory parameters are missing or if invalid values are given.