jj2000.j2k.wavelet.synthesis
Interface MultiResImgData

All Known Subinterfaces:
CBlkQuantDataSrcDec, CBlkWTDataSrcDec, CodedCBlkDataSrcDec, InvWTData
All Known Implementing Classes:
MultiResImgDataAdapter

public interface MultiResImgData

This interface defines methods to access image attributes (width, height, number of components, etc.) of multiresolution images, such as those resulting from an inverse wavelet transform. The image can be tiled or not (i.e. if the image is not tiled then there is only 1 tile). It should be implemented by all classes that provide multi-resolution image data, such as entropy decoders, dequantizers, etc. This interface, however, does not define methods to transfer image data (i.e. pixel data), that is defined by other interfaces, such as 'CBlkQuantDataSrcDec'.

This interface is very similar to the 'ImgData' one. It differs only by the fact that it handles multiple resolutions.

Resolution levels are counted from 0 to L. Resolution level 0 is the lower resolution, while L is the maximum resolution level, or full resolution, which is returned by 'getMaxResLvl()'. Note that there are L+1 resolution levels available.

As in the 'ImgData' interface a multi-resolution image lies on top of a canvas. The canvas coordinates are mapped from the full resolution reference grid (i.e. resolution level 'L' reference grid) to a resolution level 'l' reference grid by '(x_l,y_l) = (ceil(x_l/2^(L-l)),ceil(y_l/2^(L-l)))', where '(x,y)' are the full resolution reference grid coordinates and '(x_l,y_l)' are the level 'l' reference grid coordinates.

For details on the canvas system and its implications consult the 'ImgData' interface.

Note that tile sizes may not be obtained by simply dividing the tile size in the reference grid by the subsampling factor.

See Also:
ImgData, CBlkQuantDataSrcDec

Method Summary
 int getCompHeight(int n, int rl)
          Returns the height in pixels of the specified component in the current tile, for the given resolution level.
 int getCompImgHeight(int n, int rl)
          Returns the height in pixels of the specified component in the overall image, for the given resolution level.
 int getCompImgWidth(int n, int rl)
          Returns the width in pixels of the specified component in the overall image, for the given resolution level.
 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, int rl)
          Returns the width in pixels of the specified component in the current tile, for the given resolution level.
 int getHeight(int rl)
          Returns the overall height of the current tile in pixels, for the given resolution level.
 int getImgHeight(int rl)
          Returns the overall height of the image in pixels, for the given resolution level.
 int getImgULX(int rl)
          Returns the horizontal coordinate of the image origin, the top-left corner, in the canvas system, on the reference grid at the specified resolution level.
 int getImgULY(int rl)
          Returns the vertical coordinate of the image origin, the top-left corner, in the canvas system, on the reference grid at the specified resolution level.
 int getImgWidth(int rl)
          Returns the overall width of the image in pixels, for the given resolution level.
 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, int rl)
          Returns the horizontal and vertical offset of the upper-left corner of the current tile, in the specified component, relative to the canvas origin, for the specified resolution level.
 int getULX(int n, int rl)
          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 and resolution level.
 int getULY(int n, int rl)
          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 and resolution level.
 int getWidth(int rl)
          Returns the overall width of the current tile in pixels for the given resolution level.
 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.
 

Method Detail

getWidth

public int getWidth(int rl)
Returns the overall width of the current tile in pixels for the given resolution level. This is the tile's width without accounting for any component subsampling. The resolution level is indexed from the lowest number of resolution levels of all components of the current tile.
Parameters:
rl - The resolution level, from 0 to L.
Returns:
The total current tile's width in pixels.

getHeight

public int getHeight(int rl)
Returns the overall height of the current tile in pixels, for the given resolution level. This is the tile's height without accounting for any component subsampling. The resolution level is indexed from the lowest number of resolution levels of all components of the current tile.
Parameters:
rl - The resolution level, from 0 to L.
Returns:
The total current tile's height in pixels.

getImgWidth

public int getImgWidth(int rl)
Returns the overall width of the image in pixels, for the given resolution level. This is the image's width without accounting for any component subsampling or tiling. The resolution level is indexed from the lowest number of resolution levels of all components of the current tile.
Parameters:
rl - The resolution level, from 0 to L.
Returns:
The total image's width in pixels.

getImgHeight

public int getImgHeight(int rl)
Returns the overall height of the image in pixels, for the given resolution level. This is the image's height without accounting for any component subsampling or tiling. The resolution level is indexed from the lowest number of resolution levels of all components of the current tile.
Parameters:
rl - The resolution level, from 0 to L.
Returns:
The total image's height in pixels.

getNumComps

public int getNumComps()
Returns the number of components in the image.
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.
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.
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,
                        int rl)
Returns the width in pixels of the specified component in the current tile, for the given resolution level.
Parameters:
n - The index of the component, from 0 to N-1.
rl - The resolution level, from 0 to L.
Returns:
The width in pixels of component n in the current tile.

getCompHeight

public int getCompHeight(int n,
                         int rl)
Returns the height in pixels of the specified component in the current tile, for the given resolution level.
Parameters:
n - The index of the component, from 0 to N-1.
rl - The resolution level, from 0 to L.
Returns:
The height in pixels of component n in the current tile.

getCompImgWidth

public int getCompImgWidth(int n,
                           int rl)
Returns the width in pixels of the specified component in the overall image, for the given resolution level.
Parameters:
n - The index of the component, from 0 to N-1.
rl - The resolution level, from 0 to L.
Returns:
The width in pixels of component n in the overall image.

getCompImgHeight

public int getCompImgHeight(int n,
                            int rl)
Returns the height in pixels of the specified component in the overall image, for the given resolution level.
Parameters:
n - The index of the component, from 0 to N-1.
rl - The resolution level, from 0 to L.
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 indexes. An IllegalArgumentException is thrown if the indexes do not correspond to a valid tile.
Parameters:
x - The horizontal indexes the tile.
y - The vertical indexes 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).

getTile

public Coord getTile(Coord co)
Returns the indexes of the current tile. These are the horizontal and vertical indexes of the current tile.
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.
Returns:
The current tile's index (starts at 0).

getTileOff

public Coord getTileOff(Coord co,
                        int n,
                        int rl)
Returns the horizontal and vertical offset of the upper-left corner of the current tile, in the specified component, relative to the canvas origin, for the specified resolution level. This is returned in the component coordinates (not in the reference grid coordinates) reduced to the specified resolution. These are the coordinates of the current tile's (not active tile) upper-left corner relative to the canvas, in the specified component, at the specified resolution.
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)
rl - The resolution level, from 0 to L.
Returns:
The horizontal and vertical offsets of the upper-left corner of the current tile, for the specified component and resolution level, relative to the canvas origin, in the component coordinates.

getULX

public int getULX(int n,
                  int rl)
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 and resolution level. This is actually the horizontal coordinate of the top-left corner of the image data within the current tile.
Parameters:
n - The index of the component (between 0 and N-1)
rl - The resolution level, from 0 to L.
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, at resolution level 'rl'.

getULY

public int getULY(int n,
                  int rl)
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 and resolution level. This is actually the vertical coordinate of the top-left corner of the image data within the current tile.
Parameters:
n - The index of the component (between 0 and N-1)
rl - The resolution level, from 0 to L.
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, at resolution level 'rl'.

getImgULX

public int getImgULX(int rl)
Returns the horizontal coordinate of the image origin, the top-left corner, in the canvas system, on the reference grid at the specified resolution level. The resolution level is indexed from the lowest number of resolution levels of all components of the current tile.
Parameters:
rl - The resolution level, from 0 to L.
Returns:
The horizontal coordinate of the image origin in the canvas system, on the reference grid.

getImgULY

public int getImgULY(int rl)
Returns the vertical coordinate of the image origin, the top-left corner, in the canvas system, on the reference grid at the specified resolution level. The resolution level is indexed from the lowest number of resolution levels of all components of the current tile.
Parameters:
rl - The resolution level, from 0 to L.
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.
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.
Returns:
The total number of tiles in the image.