MultiResImgData (Bio-Formats API)

All Known Subinterfaces:

CBlkQuantDataSrcDec, CBlkWTDataSrcDec, CodedCBlkDataSrcDec, InvWTData

All Known Implementing Classes:

BitstreamReaderAgent, Dequantizer, EntropyDecoder, FileBitstreamReaderAgent, MultiResImgDataAdapter, ROIDeScaler, StdDequantizer, StdEntropyDecoder
```
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

Methods
Modifier and Type	Method and Description
`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 c, int rl)` Returns the width in pixels of the specified component in the overall image, for the given resolution level.
`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`	`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`	`getNomTileHeight()` Returns the nominal tiles height
`int`	`getNomTileWidth()` Returns the nominal tiles width
`int`	`getNumComps()` Returns the number of components in the image.
`int`	`getNumTiles()` Returns the total number of tiles in the image.
`Point`	`getNumTiles(Point co)` Returns the number of tiles in the horizontal and vertical directions.
`int`	`getResULX(int c, int rl)` Returns the horizontal coordinate of the upper-left corner of the specified resolution in the given component of the current tile.
`int`	`getResULY(int c, int rl)` Returns the vertical coordinate of the upper-left corner of the specified resolution in the given component of the current tile.
`SubbandSyn`	`getSynSubbandTree(int t, int c)` Returns the specified synthesis subband tree
`Point`	`getTile(Point co)` Returns the indexes of the current tile.
`int`	`getTileCompHeight(int t, int c, int rl)` Returns the height in pixels of the specified tile-component for the given resolution level.
`int`	`getTileCompWidth(int t, int c, int rl)` Returns the width in pixels of the specified tile-component for the given resolution level.
`int`	`getTileHeight(int rl)` Returns the overall height of the current tile in pixels, for the given resolution level.
`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(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
  - getTileWidth
```
int getTileWidth(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.
  - getTileHeight
```
int getTileHeight(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.
  - getNomTileWidth
```
int getNomTileWidth()
```
    Returns the nominal tiles width
  - getNomTileHeight
```
int getNomTileHeight()
```
    Returns the nominal tiles height
  - getImgWidth
```
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
```
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
```
int getNumComps()
```
    Returns the number of components in the image.
    
    Returns:
    The number of components in the image.
  - getCompSubsX
```
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.
    
    Parameters:
    c - The index of the component (between 0 and N-1)
    
    Returns:
    The horizontal subsampling factor of component 'c'
    See Also:
    ImgData
  - getCompSubsY
```
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.
    
    Parameters:
    c - The index of the component (between 0 and N-1)
    
    Returns:
    The vertical subsampling factor of component 'c'
    See Also:
    ImgData
  - getTileCompWidth
```
int getTileCompWidth(int t,
                   int c,
                   int rl)
```
    Returns the width in pixels of the specified tile-component for the given resolution level.
    
    Parameters:
    t - Tile index
    c - 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 c in tile t for resolution rl.
  - getTileCompHeight
```
int getTileCompHeight(int t,
                    int c,
                    int rl)
```
    Returns the height in pixels of the specified tile-component for the given resolution level.
    
    Parameters:
    t - The tile index.
    c - 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 c in tile t.
  - getCompImgWidth
```
int getCompImgWidth(int c,
                  int rl)
```
    Returns the width in pixels of the specified component in the overall image, for the given resolution level.
    
    Parameters:
    c - 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 c in the overall image.
  - getCompImgHeight
```
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:
    c - 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
```
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
```
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
```
Point getTile(Point 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
```
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).
  - getResULX
```
int getResULX(int c,
            int rl)
```
    Returns the horizontal coordinate of the upper-left corner of the specified resolution in the given component of the current tile.
    
    Parameters:
    c - The component index.
    rl - The resolution level index.
  - getResULY
```
int getResULY(int c,
            int rl)
```
    Returns the vertical coordinate of the upper-left corner of the specified resolution in the given component of the current tile.
    
    Parameters:
    c - The component index.
    rl - The resolution level index.
  - getImgULX
```
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
```
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.
  - getTilePartULX
```
int getTilePartULX()
```
    Returns the horizontal tile partition offset in the reference grid
  - getTilePartULY
```
int getTilePartULY()
```
    Returns the vertical tile partition offset in the reference grid
  - getNumTiles
```
Point getNumTiles(Point 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 (Point.x) and vertical (Point.y) directions.
  - getNumTiles
```
int getNumTiles()
```
    Returns the total number of tiles in the image.
    
    Returns:
    The total number of tiles in the image.
  - getSynSubbandTree
```
SubbandSyn getSynSubbandTree(int t,
                           int c)
```
    Returns the specified synthesis subband tree
    
    Parameters:
    t - Tile index.
    c - Component index.

Interface MultiResImgData

Method Summary

Method Detail

getTileWidth

getTileHeight

getNomTileWidth

getNomTileHeight

getImgWidth

getImgHeight

getNumComps

getCompSubsX

getCompSubsY

getTileCompWidth

getTileCompHeight

getCompImgWidth

getCompImgHeight

setTile

nextTile

getTile

getTileIdx

getResULX

getResULY

getImgULX

getImgULY

getTilePartULX

getTilePartULY

getNumTiles

getNumTiles

getSynSubbandTree