jp2codec.image
Class ImgDataAdapter

java.lang.Object
  extended by jp2codec.image.ImgDataAdapter
All Implemented Interfaces:
ImgData
Direct Known Subclasses:
ImgDataConverter, InvCompTransf

public abstract class ImgDataAdapter
extends java.lang.Object
implements ImgData

This class provides a default implementation of the methods in the 'ImgData' interface. The default implementation is just to return the value of the source, where the source is another 'ImgData' object.

This abstract class can be used to facilitate the development of other classes that implement 'ImgData'. For example a YCbCr color transform can inherit from this class and all the trivial methods do not have to be reimplemented.

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

See Also:
ImgData

Field Summary
protected  ImgData imgdatasrc
          The ImgData source
protected  int tIdx
          Index of the current tile
 
Constructor Summary
protected ImgDataAdapter(ImgData src)
          Instantiates the ImgDataAdapter object specifying the ImgData source.
 
Method Summary
 int getCompHeight(int n)
          Returns the height in pixels of the specified component in the current tile.
 int getCompImgHeight(int n)
          Returns the height in pixels of the specified component in the overall image.
 int getCompImgWidth(int n)
          Returns the width in pixels of the specified component in the overall image.
 int getCompSubsX(int n)
          Returns the component subsampling factor in the horizontal direction, for the specified component.
 int getCompSubsY(int n)
          Returns the component subsampling factor in the vertical direction, for the specified component.
 int getCompWidth(int n)
          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 getNomRangeBits(int n)
          Returns the number of bits, referred to as the "range bits", corresponding to the nominal range of the image data in the specified component.
 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 indexes 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 n)
          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 n)
          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 n)
          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 setTile(int x, int y)
          Changes the current tile, given the new indexes.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

tIdx

protected int tIdx
Index of the current tile


imgdatasrc

protected ImgData imgdatasrc
The ImgData source

Constructor Detail

ImgDataAdapter

protected ImgDataAdapter(ImgData src)
Instantiates the ImgDataAdapter object specifying the ImgData source.

Parameters:
src - From where to obtain all the ImgData values.
Method Detail

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.

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.

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.

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.

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 n)
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:
n - 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 n)
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:
n - 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 n)
Returns the width in pixels of the specified component in the current tile.

This default implementation returns the value of the source.

Specified by:
getCompWidth in interface ImgData
Parameters:
n - 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 n)
Returns the height in pixels of the specified component in the current tile.

This default implementation returns the value of the source.

Specified by:
getCompHeight in interface ImgData
Parameters:
n - 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 n)
Returns the width in pixels of the specified component in the overall image.

This default implementation returns the value of the source.

Specified by:
getCompImgWidth in interface ImgData
Parameters:
n - The index of the component, from 0 to N-1.
Returns:
The width in pixels of component n in the overall image.

getCompImgHeight

public int getCompImgHeight(int n)
Returns the height in pixels of the specified component in the overall image.

This default implementation returns the value of the source.

Specified by:
getCompImgHeight in interface ImgData
Parameters:
n - The index of the component, from 0 to N-1.
Returns:
The height in pixels of component n in the overall image.

getNomRangeBits

public int getNomRangeBits(int n)
Returns the number of bits, referred to as the "range bits", corresponding to the nominal range of the image data in the specified component. If this number is n then for unsigned data the nominal range is between 0 and 2^b-1, and for signed data it is between -2^(b-1) and 2^(b-1)-1. In the case of transformed data which is not in the image domain (e.g., wavelet coefficients), this method returns the "range bits" of the image data that generated the coefficients.

This default implementation returns the value of the source.

Specified by:
getNomRangeBits in interface ImgData
Parameters:
n - The index of the component.
Returns:
The number of bits corresponding to the nominal range of the image data (in the image domain).

setTile

public void setTile(int x,
                    int y)
Changes the current tile, given the new indexes. An IllegalArgumentException is thrown if the indexes do not correspond to a valid tile.

This default implementation just changes the tile in 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 just advances to the next tile in the source.

Specified by:
nextTile in interface ImgData

getTile

public Coord getTile(Coord co)
Returns the indexes 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 indexes (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 n)
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.

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

Specified by:
getULX in interface ImgData
Parameters:
n - 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 n)
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.

Specified by:
getULY in interface ImgData
Parameters:
n - 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.

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.

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.