jj2000.j2k.wavelet.synthesis
Class InvWTAdapter

java.lang.Object
  |
  +--jj2000.j2k.wavelet.synthesis.InvWTAdapter

All Implemented Interfaces:

ImgData, InvWT, WaveletTransform

Direct Known Subclasses:

InverseWT

public abstract class InvWTAdapter

extends java.lang.Object

implements InvWT

This class provides default implementation of the methods in the 'InvWT' interface. The source is always a 'MultiResImgData', which is a multi-resolution image. The default implementation is just to return the value of the source at the current image resolution level, which is set by the 'setImgResLevel()' method.

This abstract class can be used to facilitate the development of other classes that implement the 'InvWT' interface, because most of the trivial methods are already implemented.

If the default implementation of a method provided in this class does not suit a particular implementation of the 'InvWT' interface, the method can be overriden to implement the proper behaviour.

If the 'setImgResLevel()' method is overriden then it is very important that the one of this class is called from the overriding method, so that the other methods in this class return the correct values.

See Also:

InvWT

Field Summary

protected DecoderSpecs	decSpec The decoder specifications
protected int	maxImgRes The maximum available image resolution level
protected MultiResImgData	mressrc The 'MultiResImgData' source
protected int	reslvl The resquested image resolution level for reconstruction.

Fields inherited from interface jj2000.j2k.wavelet.WaveletTransform

WT_IMPL_FULL, WT_IMPL_LINE

Constructor Summary

protected

InvWTAdapter(MultiResImgData src, DecoderSpecs decSpec) Instantiates the 'InvWTAdapter' object using the specified 'MultiResImgData' source.

Method Summary

int	getCompImgHeight(int c) Returns the height in pixels of the specified component in the overall image.
int	getCompImgWidth(int c) Returns the width in pixels of the specified component in the overall image.
int	getCompSubsX(int c) Returns the component subsampling factor in the horizontal direction, for the specified component.
int	getCompSubsY(int c) Returns the component subsampling factor in the vertical direction, for the specified component.
int	getCompULX(int c) Returns the horizontal coordinate of the upper-left corner of the specified component in the current tile.
int	getCompULY(int c) Returns the vertical coordinate of the upper-left corner of the specified component in the current tile.
int	getImgHeight() Returns the overall height of the image in pixels.
int	getImgULX() Returns the horizontal coordinate of the image origin, the top-left corner, in the canvas system, on the reference grid.
int	getImgULY() Returns the vertical coordinate of the image origin, the top-left corner, in the canvas system, on the reference grid.
int	getImgWidth() Returns the overall width of the image in pixels.
int	getNomTileHeight() Returns the nominal height of tiles
int	getNomTileWidth() Returns the nominal width of tiles
int	getNumComps() Returns the number of components in the image.
int	getNumTiles() Returns the total number of tiles in the image.
Coord	getNumTiles(Coord co) Returns the number of tiles in the horizontal and vertical directions.
SubbandSyn	getSynSubbandTree(int t, int c) Returns the specified synthesis subband tree
Coord	getTile(Coord co) Returns the indixes of the current tile.
int	getTileCompHeight(int t, int c) Returns the height in pixels of the specified tile-component.
int	getTileCompWidth(int t, int c) Returns the width in pixels of the specified tile-component
int	getTileHeight() Returns the overall height of the current tile in pixels.
int	getTileIdx() Returns the index of the current tile, relative to a standard scan-line order.
int	getTilePartULX() Returns the horizontal tile partition offset in the reference grid
int	getTilePartULY() Returns the vertical tile partition offset in the reference grid
int	getTileWidth() Returns the overall width of the current tile in pixels.
void	nextTile() Advances to the next tile, in standard scan-line order (by rows then columns).
void	setImgResLevel(int rl) Sets the image reconstruction resolution level.
void	setTile(int x, int y) Changes the current tile, given the new indices.

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.WaveletTransform

getImplementationType, isReversible

Methods inherited from interface jj2000.j2k.image.ImgData

getNomRangeBits

Field Detail

decSpec

protected DecoderSpecs decSpec

The decoder specifications

mressrc

protected MultiResImgData mressrc

The 'MultiResImgData' source

reslvl

protected int reslvl

The resquested image resolution level for reconstruction.

maxImgRes

protected int maxImgRes

The maximum available image resolution level

Constructor Detail

InvWTAdapter

protected InvWTAdapter(MultiResImgData src,
                       DecoderSpecs decSpec)

Instantiates the 'InvWTAdapter' object using the specified 'MultiResImgData' source. The reconstruction resolution level is set to full resolution (i.e. the maximum resolution level).

Parameters:

src - From where to obtain the values to return

decSpec - The decoder specifications

Method Detail

setImgResLevel

public void setImgResLevel(int rl)

Sets the image reconstruction resolution level. A value of 0 means reconstruction of an image with the lowest resolution (dimension) available.

Note: Image resolution level indexes may differ from tile-component resolution index. They are indeed indexed starting from the lowest number of decomposition levels of each component of each tile.

Example: For an image (1 tile) with 2 components (component 0 having 2 decomposition levels and component 1 having 3 decomposition levels), the first (tile-) component has 3 resolution levels and the second one has 4 resolution levels, whereas the image has only 3 resolution levels available.

Specified by:

setImgResLevel in interface InvWT

Parameters:

rl - The image resolution level.

Returns:

The vertical coordinate of the image origin in the canvas system, on the reference grid.

getTileWidth

public int getTileWidth()

Returns the overall width of the current tile in pixels. This is the tile's width without accounting for any component subsampling. This is also referred as the reference grid width in the current tile.

This default implementation returns the value of the source at the current reconstruction resolution level.

Specified by:

getTileWidth in interface ImgData

Returns:

The total current tile's width in pixels.

getTileHeight

public int getTileHeight()

Returns the overall height of the current tile in pixels. This is the tile's height without accounting for any component subsampling. This is also referred as the reference grid height in the current tile.

This default implementation returns the value of the source at the current reconstruction resolution level.

Specified by:

getTileHeight in interface ImgData

Returns:

The total current tile's height in pixels.

getNomTileWidth

public int getNomTileWidth()

Returns the nominal width of tiles

Specified by:

getNomTileWidth in interface ImgData

getNomTileHeight

public int getNomTileHeight()

Returns the nominal height of tiles

Specified by:

getNomTileHeight in interface ImgData

getImgWidth

public int getImgWidth()

Returns the overall width of the image in pixels. This is the image's width without accounting for any component subsampling or tiling.

Specified by:

getImgWidth in interface ImgData

Returns:

The total image's width in pixels.

getImgHeight

public int getImgHeight()

Returns the overall height of the image in pixels. This is the image's height without accounting for any component subsampling or tiling.

Specified by:

getImgHeight in interface ImgData

Returns:

The total image's height in pixels.

getNumComps

public int getNumComps()

Returns the number of components in the image.

Specified by:

getNumComps in interface ImgData

Returns:

The number of components in the image.

getCompSubsX

public int getCompSubsX(int c)

Returns the component subsampling factor in the horizontal direction, for the specified component. This is, approximately, the ratio of dimensions between the reference grid and the component itself, see the 'ImgData' interface desription for details.

Specified by:

getCompSubsX in interface ImgData

Parameters:

c - The index of the component (between 0 and N-1).

Returns:

The horizontal subsampling factor of component 'c'.

See Also:

ImgData

getCompSubsY

public int getCompSubsY(int c)

Returns the component subsampling factor in the vertical direction, for the specified component. This is, approximately, the ratio of dimensions between the reference grid and the component itself, see the 'ImgData' interface desription for details.

Specified by:

getCompSubsY in interface ImgData

Parameters:

c - The index of the component (between 0 and N-1).

Returns:

The vertical subsampling factor of component 'c'.

See Also:

ImgData

getTileCompWidth

public int getTileCompWidth(int t,
                            int c)

Returns the width in pixels of the specified tile-component

Specified by:

getTileCompWidth in interface ImgData

Parameters:

t - Tile index

c - The index of the component, from 0 to N-1.

Returns:

The width in pixels of component n in tile t.

getTileCompHeight

public int getTileCompHeight(int t,
                             int c)

Returns the height in pixels of the specified tile-component.

This default implementation returns the value of the source at the current reconstruction resolution level.

Specified by:

getTileCompHeight in interface ImgData

Parameters:

t - The tile index.

c - The index of the component, from 0 to N-1.

Returns:

The height in pixels of component n in tile t.

getCompImgWidth

public int getCompImgWidth(int c)

Returns the width in pixels of the specified component in the overall image.

Specified by:

getCompImgWidth in interface ImgData

Parameters:

c - The index of the component, from 0 to N-1.

Returns:

The width in pixels of component c in the overall image.

getCompImgHeight

public int getCompImgHeight(int c)

Returns the height in pixels of the specified component in the overall image.

This default implementation returns the value of the source at the current reconstruction resolution level.

Specified by:

getCompImgHeight in interface ImgData

Parameters:

c - The index of the component, from 0 to N-1.

Returns:

The height in pixels of component n in the overall image.

setTile

public void setTile(int x,
                    int y)

Changes the current tile, given the new indices. An IllegalArgumentException is thrown if the coordinates do not correspond to a valid tile.

This default implementation calls the same method on the source.

Specified by:

setTile in interface ImgData

Parameters:

x - The horizontal index of the tile.

y - The vertical index 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 default implementation calls the same method on the source.

Specified by:

nextTile in interface ImgData

getTile

public Coord getTile(Coord co)

Returns the indixes of the current tile. These are the horizontal and vertical indexes of the current tile.

This default implementation returns the value of the source.

Specified by:

getTile in interface ImgData

Parameters:

co - If not null this object is used to return the information. If null a new one is created and returned.

Returns:

The current tile's indices (vertical and horizontal indexes).

getTileIdx

public int getTileIdx()

Returns the index of the current tile, relative to a standard scan-line order.

This default implementation returns the value of the source.

Specified by:

getTileIdx in interface ImgData

Returns:

The current tile's index (starts at 0).

getCompULX

public int getCompULX(int c)

Returns the horizontal coordinate of the upper-left corner of the specified component in the current tile.

Specified by:

getCompULX in interface ImgData

Parameters:

c - The component index.

getCompULY

public int getCompULY(int c)

Returns the vertical coordinate of the upper-left corner of the specified component in the current tile.

Specified by:

getCompULY in interface ImgData

Parameters:

c - The component index.

getImgULX

public int getImgULX()

Returns the horizontal coordinate of the image origin, the top-left corner, in the canvas system, on the reference grid.

This default implementation returns the value of the source at the current reconstruction resolution level.

Specified by:

getImgULX in interface ImgData

Returns:

The horizontal coordinate of the image origin in the canvas system, on the reference grid.

getImgULY

public int getImgULY()

Returns the vertical coordinate of the image origin, the top-left corner, in the canvas system, on the reference grid.

This default implementation returns the value of the source at the current reconstruction resolution level.

Specified by:

getImgULY in interface ImgData

Returns:

The vertical coordinate of the image origin in the canvas system, on the reference grid.

getTilePartULX

public int getTilePartULX()

Returns the horizontal tile partition offset in the reference grid

Specified by:

getTilePartULX in interface ImgData

getTilePartULY

public int getTilePartULY()

Returns the vertical tile partition offset in the reference grid

Specified by:

getTilePartULY in interface ImgData

getNumTiles

public Coord getNumTiles(Coord co)

Returns the number of tiles in the horizontal and vertical directions.

This default implementation returns the value of the source.

Specified by:

getNumTiles in interface ImgData

Parameters:

co - If not null this object is used to return the information. If null a new one is created and returned.

Returns:

The number of tiles in the horizontal (Coord.x) and vertical (Coord.y) directions.

getNumTiles

public int getNumTiles()

Returns the total number of tiles in the image.

This default implementation returns the value of the source.

Specified by:

getNumTiles in interface ImgData

Returns:

The total number of tiles in the image.

getSynSubbandTree

public SubbandSyn getSynSubbandTree(int t,
                                    int c)

Returns the specified synthesis subband tree

Parameters:

t - Tile index.

c - Component index.