jj2000.j2k.wavelet.analysis
Class ForwWTFull

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

All Implemented Interfaces:

CBlkWTDataSrc, ForwWT, ForwWTDataProps, ImgData, WaveletTransform

public class ForwWTFull

extends ForwardWT

This class implements the ForwardWT abstract class with the full-page approach to be used either with integer or floating-point filters

See Also:

ForwardWT

Field Summary

private int	cb0x The horizontal coordinate of the code-block partition origin on the reference grid
private int	cb0y The vertical coordinate of the code-block partition on the reference grid
private CBlkSizeSpec	cblks The code-block size specifications
(package private) SubbandAn[]	currentSubband The subband being dealt with in each component
private DataBlk[]	decomposedComps Block storing the full band decomposition for each component.
private IntegerSpec	dls The number of decomposition levels specification
private AnWTFilterSpec	filters Wavelet filters for all components and tiles
private boolean	intData Boolean to know if one are currently dealing with int or float data.
private int[]	lastm The vertical index of the last "sent" code-block in the current subband in each component.
private int[]	lastn The horizontal index of the last "sent" code-block in the current subband in each component.
(package private) Coord	ncblks Cache object to avoid excessive allocation/desallocation.
private PrecinctSizeSpec	pss The precinct partition specifications
private BlkImgDataSrc	src The source of image data
private SubbandAn[][]	subbTrees The subband trees of each tile-component.

Fields inherited from class jj2000.j2k.wavelet.analysis.ForwardWT

OPT_PREFIX, WT_DECOMP_DYADIC

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

ForwWTFull(BlkImgDataSrc src, EncoderSpecs encSpec, int cb0x, int cb0y)
Initializes this object with the given source of image data and with all the decompositon parameters

Method Summary

SubbandAn	getAnSubbandTree(int t, int c) Returns a reference to the subband tree structure representing the subband decomposition for the specified tile-component of the source.
int	getCbULX() Returns the horizontal offset of the code-block partition.
int	getCbULY() Returns the vertical offset of the code-block partition.
int	getDataType(int t, int c) Return the data type of this CBlkWTDataSrc.
int	getDecomp(int t, int c) Returns the wavelet tree decomposition.
int	getDecompLevels(int t, int c) Returns the number of decomposition levels that are applied to the LL band, in the specified tile-component.
int	getFixedPoint(int c) Returns the position of the fixed point in the specified component.
AnWTFilter[]	getHorAnWaveletFilters(int t, int c) Returns the horizontal analysis wavelet filters used in each level, for the specified component and tile.
int	getImplementationType(int c) Returns the implementation type of this wavelet transform, WT_IMPL_FULL (full-page based transform).
CBlkWTData	getNextCodeBlock(int c, CBlkWTData cblk) Returns the next code-block in the current tile for the specified component, as a copy (see below).
CBlkWTData	getNextInternCodeBlock(int c, CBlkWTData cblk) Returns the next code-block in the current tile for the specified component.
private SubbandAn	getNextSubband(int c) Returns the next subband that will be used to get the next code-block to return by the getNext[Intern]CodeBlock method.
AnWTFilter[]	getVertAnWaveletFilters(int t, int c) Returns the vertical analysis wavelet filters used in each level, for the specified component and tile.
private void	initSubbandsFields(int t, int c, Subband sb) Initialises subbands fields, such as number of code-blocks and code-blocks dimension, in the subband tree.
boolean	isReversible(int t, int c) Returns the reversibility of the wavelet transform for the specified component and tile.
void	nextTile() Advances to the next tile, in standard scan-line order (by rows then columns).
void	setTile(int x, int y) Changes the current tile, given the new coordinates.
private void	wavelet2DDecomposition(DataBlk band, SubbandAn subband, int c) Performs the 2D forward wavelet transform on a subband of the initial band.
private void	waveletTreeDecomposition(DataBlk band, SubbandAn subband, int c) Performs the forward wavelet transform on the whole band.

Methods inherited from class jj2000.j2k.wavelet.analysis.ForwardWT

createInstance, getParameterInfo

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

Methods inherited from class java.lang.Object

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

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

Field Detail

intData

private boolean intData

Boolean to know if one are currently dealing with int or float data.

subbTrees

private SubbandAn[][] subbTrees

The subband trees of each tile-component. The array is allocated by the constructor of this class and updated by the getAnSubbandTree() method when needed. The first index is the tile index (in lexicographical order) and the second index is the component index.

The subband tree for a component in the current tile is created on the first call to getAnSubbandTree() for that component, in the current tile. Before that, the element in 'subbTrees' is null.

src

private BlkImgDataSrc src

The source of image data

cb0x

private int cb0x

The horizontal coordinate of the code-block partition origin on the reference grid

cb0y

private int cb0y

The vertical coordinate of the code-block partition on the reference grid

dls

private IntegerSpec dls

The number of decomposition levels specification

filters

private AnWTFilterSpec filters

Wavelet filters for all components and tiles

cblks

private CBlkSizeSpec cblks

The code-block size specifications

pss

private PrecinctSizeSpec pss

The precinct partition specifications

decomposedComps

private DataBlk[] decomposedComps

Block storing the full band decomposition for each component.

lastn

private int[] lastn

The horizontal index of the last "sent" code-block in the current subband in each component. It should be -1 if none have been sent yet.

lastm

private int[] lastm

The vertical index of the last "sent" code-block in the current subband in each component. It should be 0 if none have been sent yet.

currentSubband

SubbandAn[] currentSubband

The subband being dealt with in each component

ncblks

Coord ncblks

Cache object to avoid excessive allocation/desallocation. This variable makes the class inheritently thread unsafe.

Constructor Detail

ForwWTFull

public ForwWTFull(BlkImgDataSrc src,
                  EncoderSpecs encSpec,
                  int cb0x,
                  int cb0y)

Initializes this object with the given source of image data and with all the decompositon parameters

Parameters:

src - From where the image data should be obtained.

encSpec - The encoder specifications

cb0x - The horizontal coordinate of the code-block partition origin on the reference grid.

cb0y - The vertical coordinate of the code-block partition origin on the reference grid.

See Also:

ForwardWT

Method Detail

getImplementationType

public int getImplementationType(int c)

Returns the implementation type of this wavelet transform, WT_IMPL_FULL (full-page based transform). All components return the same.

Parameters:

c - The index of the component.

Returns:

WT_IMPL_FULL

getDecompLevels

public int getDecompLevels(int t,
                           int c)

Returns the number of decomposition levels that are applied to the LL band, in the specified tile-component. A value of 0 means that no wavelet transform is applied.

Parameters:

t - The tile index

c - The index of the component.

Returns:

The number of decompositions applied to the LL band (0 for no wavelet transform).

getDecomp

public int getDecomp(int t,
                     int c)

Returns the wavelet tree decomposition. Actually JPEG 2000 part 1 only supports WT_DECOMP_DYADIC decomposition.

Parameters:

t - The tile-index

c - The index of the component.

Returns:

The wavelet decomposition.

getHorAnWaveletFilters

public AnWTFilter[] getHorAnWaveletFilters(int t,
                                           int c)

Returns the horizontal analysis wavelet filters used in each level, for the specified component and tile. The first element in the array is the filter used to obtain the lowest resolution (resolution level 0) subbands (i.e. lowest frequency LL subband), the second element is the one used to generate the resolution level 1 subbands, and so on. If there are less elements in the array than the number of resolution levels, then the last one is assumed to repeat itself.

The returned filters are applicable only to the specified component and in the current tile.

The resolution level of a subband is the resolution level to which a subband contributes, which is different from its decomposition level.

Parameters:

t - The index of the tile for which to return the filters.

c - The index of the component for which to return the filters.

Returns:

The horizontal analysis wavelet filters used in each level.

getVertAnWaveletFilters

public AnWTFilter[] getVertAnWaveletFilters(int t,
                                            int c)

Returns the vertical analysis wavelet filters used in each level, for the specified component and tile. The first element in the array is the filter used to obtain the lowest resolution (resolution level 0) subbands (i.e. lowest frequency LL subband), the second element is the one used to generate the resolution level 1 subbands, and so on. If there are less elements in the array than the number of resolution levels, then the last one is assumed to repeat itself.

The returned filters are applicable only to the specified component and in the current tile.

The resolution level of a subband is the resolution level to which a subband contributes, which is different from its decomposition level.

Parameters:

t - The index of the tile for which to return the filters.

c - The index of the component for which to return the filters.

Returns:

The vertical analysis wavelet filters used in each level.

isReversible

public boolean isReversible(int t,
                            int c)

Returns the reversibility of the wavelet transform for the specified component and tile. A wavelet transform is reversible when it is suitable for lossless and lossy-to-lossless compression.

Parameters:

t - The index of the tile.

c - The index of the component.

Returns:

true is the wavelet transform is reversible, false if not.

getCbULX

public int getCbULX()

Returns the horizontal offset of the code-block partition. Allowable values are 0 and 1, nothing else.

getCbULY

public int getCbULY()

Returns the vertical offset of the code-block partition. Allowable values are 0 and 1, nothing else.

getFixedPoint

public int getFixedPoint(int c)

Returns the position of the fixed point in the specified component. This is the position of the least significant integral (i.e. non-fractional) bit, which is equivalent to the number of fractional bits. For instance, for fixed-point values with 2 fractional bits, 2 is returned. For floating-point data this value does not apply and 0 should be returned. Position 0 is the position of the least significant bit in the data.

Parameters:

c - The index of the component.

Returns:

The position of the fixed-point, which is the same as the number of fractional bits. For floating-point data 0 is returned.

getNextInternCodeBlock

public CBlkWTData getNextInternCodeBlock(int c,
                                         CBlkWTData cblk)

Returns the next code-block in the current tile for the specified component. The order in which code-blocks are returned is not specified. However each code-block is returned only once and all code-blocks will be returned if the method is called 'N' times, where 'N' is the number of code-blocks in the tile. After all the code-blocks have been returned for the current tile calls to this method will return 'null'.

When changing the current tile (through 'setTile()' or 'nextTile()') this method will always return the first code-block, as if this method was never called before for the new current tile.

The data returned by this method is the data in the internal buffer of this object, and thus can not be modified by the caller. The 'offset' and 'scanw' of the returned data have, in general, some non-zero value. The 'magbits' of the returned data is not set by this method and should be ignored. See the 'CBlkWTData' class.

The 'ulx' and 'uly' members of the returned 'CBlkWTData' object contain the coordinates of the top-left corner of the block, with respect to the tile, not the subband.

Parameters:

c - The component for which to return the next code-block.

cblk - If non-null this object will be used to return the new code-block. If null a new one will be allocated and returned.

Returns:

The next code-block in the current tile for component 'n', or null if all code-blocks for the current tile have been returned.

See Also:

CBlkWTData

getNextCodeBlock

public CBlkWTData getNextCodeBlock(int c,
                                   CBlkWTData cblk)

Returns the next code-block in the current tile for the specified component, as a copy (see below). The order in which code-blocks are returned is not specified. However each code-block is returned only once and all code-blocks will be returned if the method is called 'N' times, where 'N' is the number of code-blocks in the tile. After all the code-blocks have been returned for the current tile calls to this method will return 'null'.

When changing the current tile (through 'setTile()' or 'nextTile()') this method will always return the first code-block, as if this method was never called before for the new current tile.

The data returned by this method is always a copy of the internal data of this object, and it can be modified "in place" without any problems after being returned. The 'offset' of the returned data is 0, and the 'scanw' is the same as the code-block width. The 'magbits' of the returned data is not set by this method and should be ignored. See the 'CBlkWTData' class.

The 'ulx' and 'uly' members of the returned 'CBlkWTData' object contain the coordinates of the top-left corner of the block, with respect to the tile, not the subband.

Parameters:

c - The component for which to return the next code-block.

cblk - If non-null this object will be used to return the new code-block. If null a new one will be allocated and returned. If the "data" array of the object is non-null it will be reused, if possible, to return the data.

Returns:

The next code-block in the current tile for component 'c', or null if all code-blocks for the current tile have been returned.

See Also:

CBlkWTData

getDataType

public int getDataType(int t,
                       int c)

Return the data type of this CBlkWTDataSrc. Its value should be either DataBlk.TYPE_INT or DataBlk.TYPE_FLOAT but can change according to the current tile-component.

Parameters:

t - The index of the tile for which to return the data type.

c - The index of the component for which to return the data type.

Returns:

Current data type

getNextSubband

private SubbandAn getNextSubband(int c)

Returns the next subband that will be used to get the next code-block to return by the getNext[Intern]CodeBlock method.

Parameters:

c - The component

Returns:

Its returns the next subband that will be used to get the next code-block to return by the getNext[Intern]CodeBlock method.

waveletTreeDecomposition

private void waveletTreeDecomposition(DataBlk band,
                                      SubbandAn subband,
                                      int c)

Performs the forward wavelet transform on the whole band. It iteratively decomposes the subbands from the top node to the leaves.

Parameters:

band - The band containing the float data to decompose

subband - The structure containing the coordinates of the current subband in the whole band to decompose.

c - The index of the current component to decompose

wavelet2DDecomposition

private void wavelet2DDecomposition(DataBlk band,
                                    SubbandAn subband,
                                    int c)

Performs the 2D forward wavelet transform on a subband of the initial band. This method will successively perform 1D filtering steps on all lines and then all columns of the subband. In this class only filters with floating point implementations can be used.

Parameters:

band - The band containing the float data to decompose

subband - The structure containing the coordinates of the subband in the whole band to decompose.

c - The index of the current component to decompose

setTile

public void setTile(int x,
                    int y)

Changes the current tile, given the new coordinates.

This method resets the 'subbTrees' array, and recalculates the values of the 'reversible' array. It also resets the decomposed component buffers.

Specified by:

setTile in interface ImgData

Overrides:

setTile in class ImgDataAdapter

Parameters:

x - The horizontal coordinate of the tile.

y - The vertical coordinate of the new tile.

nextTile

public void nextTile()

Advances to the next tile, in standard scan-line order (by rows then columns). An NoNextElementException is thrown if the current tile is the last one (i.e. there is no next tile).

This method resets the 'subbTrees' array, and recalculates the values of the 'reversible' array. It also resets the decomposed component buffers.

Specified by:

nextTile in interface ImgData

Overrides:

nextTile in class ImgDataAdapter

getAnSubbandTree

public SubbandAn getAnSubbandTree(int t,
                                  int c)

Returns a reference to the subband tree structure representing the subband decomposition for the specified tile-component of the source.

Parameters:

t - The index of the tile.

c - The index of the component.

Returns:

The subband tree structure, see Subband.

See Also:

SubbandAn, Subband

initSubbandsFields

private void initSubbandsFields(int t,
                                int c,
                                Subband sb)

Initialises subbands fields, such as number of code-blocks and code-blocks dimension, in the subband tree. The nominal code-block width/height depends on the precincts dimensions if used.

Parameters:

t - The tile index of the subband

c - The component index

sb - The subband tree to be initialised.