jp2codec.wavelet.synthesis
Class InvWTAdapter

java.lang.Object
  extended by jp2codec.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  MultiResImgData mressrc
          The 'MultiResImgData' source
 
Fields inherited from interface jp2codec.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 getCompHeight(int c)
          Returns the height in pixels of the specified component in the current tile.
 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 getCompWidth(int c)
          Returns the width in pixels of the specified component in the current tile.
 int getHeight()
          Returns the overall height of the current tile in pixels.
 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 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.
 Coord getTile(Coord co)
          Returns the indixes of the current tile.
 int getTileIdx()
          Returns the index of the current tile, relative to a standard scan-line order.
 Coord getTileOff(Coord co, int c)
          Returns the horizontal and vertical offset of the upper-left corner of the current tile, in the specified component, relative to the canvas origin, in the component coordinates (not in the reference grid coordinates).
 int getULX(int c)
          Returns the horizontal coordinate of the upper-left corner of the active tile, with respect to the canvas origin, in the component coordinates, for the specified component.
 int getULY(int c)
          Returns the vertical coordinate of the upper-left corner of the active tile, with respect to the canvas origin, in the component coordinates, for the specified component.
 int getWidth()
          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 jp2codec.wavelet.WaveletTransform
getImplementationType, isReversible
 
Methods inherited from interface jp2codec.image.ImgData
getNomRangeBits
 

Field Detail

decSpec

protected DecoderSpecs decSpec
The decoder specifications


mressrc

protected MultiResImgData mressrc
The 'MultiResImgData' source

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.

getWidth

public int getWidth()
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:
getWidth in interface ImgData
Returns:
The total current tile's width in pixels.

getHeight

public int getHeight()
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:
getHeight in interface ImgData
Returns:
The total current tile's height in pixels.

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.

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

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.

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

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.

This default implementation returns the value of the source.

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.

This default implementation returns the value of the source.

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 'n'
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.

This default implementation returns the value of the source.

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 'n'
See Also:
ImgData

getCompWidth

public int getCompWidth(int c)
Returns the width in pixels of the specified component in the current tile.

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

Specified by:
getCompWidth in interface ImgData
Parameters:
c - The index of the component, from 0 to N-1.
Returns:
The width in pixels of component n in the current tile.

getCompHeight

public int getCompHeight(int c)
Returns the height in pixels of the specified component in the current tile.

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

Specified by:
getCompHeight 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 current tile.

getCompImgWidth

public int getCompImgWidth(int c)
Returns the width 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:
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).

getTileOff

public Coord getTileOff(Coord co,
                        int c)
Returns the horizontal and vertical offset of the upper-left corner of the current tile, in the specified component, relative to the canvas origin, in the component coordinates (not in the reference grid coordinates). These are the coordinates of the current tile's (not active tile) upper-left corner relative to the canvas.

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

Specified by:
getTileOff in interface ImgData
Parameters:
co - If not null the object is used to return the values, if null a new one is created and returned.
c - The index of the component (between 0 and N-1)
Returns:
The horizontal and vertical offsets of the upper-left corner of the current tile, for the specified component, relative to the canvas origin, in the component coordinates.

getULX

public int getULX(int c)
Returns the horizontal coordinate of the upper-left corner of the active tile, with respect to the canvas origin, in the component coordinates, for the specified component.

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

Specified by:
getULX in interface ImgData
Parameters:
c - The index of the component (between 0 and N-1)
Returns:
The horizontal coordinate of the upper-left corner of the active tile, with respect to the canvas origin, for component 'n', in the component coordinates.

getULY

public int getULY(int c)
Returns the vertical coordinate of the upper-left corner of the active tile, with respect to the canvas origin, in the component coordinates, for the specified component.

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

Specified by:
getULY in interface ImgData
Parameters:
c - The index of the component (between 0 and N-1)
Returns:
The vertical coordinate of the upper-left corner of the active tile, with respect to the canvas origin, for component 'n', in the component coordinates.

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.

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.