| Name | Description | |
|---|---|---|
 | OPT_PREFIX | The prefix for bit stream reader options: 'B' |
The following tables list the members exposed by BitstreamReaderAgent.
| Name | Description | |
|---|---|---|
| OPT_PREFIX | The prefix for bit stream reader options: 'B' |
| Name | Description | |
|---|---|---|
 | ActualNbytes | Return the actual number of read bytes. |
| ActualRate | Return the actual decoding rate in bits per pixel. |
| CbULX | Returns the horizontal code-block partition origin. Allowable values are 0 and 1, nothing else. |
| CbULY | Returns the vertical code-block partition origin. Allowable values are 0 and 1, nothing else. |
| ImgRes | Returns the image resolution level to reconstruct from the codestream. This value cannot be computed before every main and tile headers are read. |
| NomTileHeight | Returns the nominal tile height |
| NomTileWidth | Returns the nominal tile width |
| NumComps | Returns the number of components in the image. |
 | ParameterInfo | Returns the parameters that are used in this class and implementing classes. It returns a 2D String array. Each of the 1D arrays is for a different option, and they have 3 elements. The first element is the option name, the second one is the synopsis and the third one is a long description of what the parameter is. The synopsis or description may be 'null', in which case it is assumed that there is no synopsis or description of the option, respectively. Null may be returned if no options are supported. |
| TargetNbytes | Return the target number of read bytes. |
| TargetRate | Return the target decoding rate in bits per pixel. |
| TileIdx | Returns the index of the current tile, relative to a standard scan-line order. |
| TilePartULX | Returns the horizontal offset of tile partition |
| TilePartULY | Returns the vertical offset of tile partition |
| Name | Description | |
|---|---|---|
 | createInstance | Creates a bit stream reader of the correct type that works on the provided RandomAccessIO, with the special parameters from the parameter list. |
| getCodeBlock | |
| getCompImgHeight | Returns the height in pixels of the specified component in the overall image, for the given (component) resolution level.
Note: Component resolution level indexes may differ from tile-component resolution index. They are indeed indexed starting from the lowest number of decomposition levels of same component of each tile. Example: For an image (2 tiles) with 1 component (tile 0 having 2 decomposition levels and tile 1 having 3 decomposition levels), the first tile(-component) has 3 resolution levels and the second one has 4 resolution levels, whereas the component has only 3 resolution levels available. |
| getCompImgWidth | Returns the width in pixels of the specified component in the overall image, for the given (component) resolution level.
Note: Component resolution level indexes may differ from tile-component resolution index. They are indeed indexed starting from the lowest number of decomposition levels of same component of each tile. Example: For an image (2 tiles) with 1 component (tile 0 having 2 decomposition levels and tile 1 having 3 decomposition levels), the first tile(-component) has 3 resolution levels and the second one has 4 resolution levels, whereas the component has only 3 resolution levels available. |
| getCompSubsX | 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. |
| getCompSubsY | 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. |
| getImgHeight | 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.
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. |
| getImgULX | 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.
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. |
| getImgULY | 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.
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. |
| getImgWidth | Returns the overall width of the image in pixels, for the given (image) resolution level. This is the image's width without accounting for any component subsampling or tiling.
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. |
| getNumTiles | Overloaded. Returns the number of tiles in the horizontal and vertical directions. |
| getPPX | Returns the precinct partition width for the specified tile-component and (tile-component) resolution level. |
| getPPY | Returns the precinct partition height for the specified tile-component and (tile-component) resolution level. |
| getResULX | Returns the horizontal coordinate of the upper-left corner of the specified resolution in the given component of the current tile. |
| getResULY | Returns the vertical coordinate of the upper-left corner of the specified component in the given component of the current tile. |
| getSynSubbandTree | Returns the subband tree, for the specified tile-component. This method returns the root element of the subband tree structure, see Subband and SubbandSyn. The tree comprises all the available resolution levels.
Note: this method is not able to return subband tree for a tile different than the current one. The number of magnitude bits ('magBits' member variable) for each subband is not initialized. |
| getTile | Returns the indexes of the current tile. These are the horizontal and vertical indexes of the current tile. |
| getTileCompHeight | Returns the height in pixels of the specified tile-component for the given (tile-component) resolution level. |
| getTileCompWidth | Returns the width in pixels of the specified tile-component for the given (tile-component) resolution level. |
| getTileHeight | 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.
Note: Tile resolution level indexes may be different from tile-component resolution index. They are indeed indexed starting from the lowest number of decomposition levels of each component of the tile. 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 tile has only 3 resolution levels available. |
| getTileWidth | Returns the overall width of the current tile in pixels for the given (tile) resolution level. This is the tile's width without accounting for any component subsampling.
Note: Tile resolution level indexes may be different from tile-component resolution index. They are indeed indexed starting from the lowest number of decomposition levels of each component of the tile. 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 tile has only 3 resolution levels available. |
| 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). |
| setTile | Changes the current tile, given the new indexes. An IllegalArgumentException is thrown if the indexes do not correspond to a valid tile. |