StdEntropyCoder Class Members
In This Topic
The following tables list the members exposed by StdEntropyCoder.
Public Constructors
| Name | Description |
| StdEntropyCoder Constructor | Instantiates a new entropy coder engine, with the specified source of data, nominal block width and height.
If the 'OPT_PRED_TERM' option is given then the MQ termination must be 'TERM_PRED_ER' or an exception is thrown. |
Top
Public Fields
| Name | Description |
| bms | By-pass mode specifications |
| css | Causal stripes specifications |
| DEF_THREADS_NUM | The default value for the property in THREADS_PROP_NAME: 0 |
| lcs | The length calculation specifications |
| mqrs | MQ reset specifications |
| rts | Regular termination specifications |
| sss | Error resilience segment symbol use specifications |
| THREADS_PRIORITY_INC | The increase in priority for the compressor threads, currently 3. The compressor threads will have a priority of THREADS_PRIORITY_INC more than the priority of the thread calling this class constructor. Used only in the multi-threaded implementation. |
| THREADS_PROP_NAME | The Java system property name for the number of threads to use: jj2000.j2k.entropy.encoder.StdEntropyCoder.nthreads |
| tts | The termination type specifications |
Top
Public Properties
Public Methods
| Name | Description |
| getAnSubbandTree | Returns a reference to the root of subband tree structure representing the subband decomposition for the specified tile-component. (Inherited from CSJ2K.j2k.entropy.encoder.EntropyCoder) |
| getCBlkHeight | Overridden. Returns the code-block height for the specified tile and component. |
| getCBlkWidth | Overridden. Returns the code-block width for the specified tile and component. |
| getCompImgHeight | Returns the height in pixels of the specified component in the overall image.
This default implementation returns the value of the source. (Inherited from CSJ2K.j2k.image.ImgDataAdapter) |
| getCompImgWidth | Returns the width in pixels of the specified component in the overall image.
This default implementation returns the value of the source. (Inherited from CSJ2K.j2k.image.ImgDataAdapter) |
| 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.
This default implementation returns the value of the source. (Inherited from CSJ2K.j2k.image.ImgDataAdapter) |
| 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.
This default implementation returns the value of the source. (Inherited from CSJ2K.j2k.image.ImgDataAdapter) |
| getCompULX | Returns the horizontal coordinate of the upper-left corner of the specified component in the current tile.
This default implementation returns the value of the source. (Inherited from CSJ2K.j2k.image.ImgDataAdapter) |
| getCompULY | Returns the vertical coordinate of the upper-left corner of the specified component in the current tile.
This default implementation returns the value of the source. (Inherited from CSJ2K.j2k.image.ImgDataAdapter) |
| getNextCodeBlock | Overridden. Returns the next coded code-block in the current tile for the specified component, as a copy (see below). The order in which code-blocks are returned is not specified. However each code-block is returned only once and all code-blocks will be returned if the method is called 'N' times, where 'N' is the number of code-blocks in the tile. After all the code-blocks have been returned for the current tile calls to this method will return 'null'.
When changing the current tile (through 'setTile()' or 'nextTile()') this method will always return the first code-block, as if this method was never called before for the new current tile.
The data returned by this method is always a copy of the internal data of this object, if any, and it can be modified "in place" without any problems after being returned. |
| getNomRangeBits | (Inherited from CSJ2K.j2k.image.ImgDataAdapter) |
| getNumTiles | Overloaded. Returns the number of tiles in the horizontal and vertical directions.
This default implementation returns the value of the source. (Inherited from CSJ2K.j2k.image.ImgDataAdapter) |
| getPPX | Overridden. Returns the precinct partition width for the specified component, tile and resolution level. |
| getPPY | Overridden. Returns the precinct partition height for the specified component, tile and resolution level. |
| getTile | 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. (Inherited from CSJ2K.j2k.image.ImgDataAdapter) |
| getTileCompHeight | Returns the height in pixels of the specified tile-component.
This default implementation returns the value of the source. (Inherited from CSJ2K.j2k.image.ImgDataAdapter) |
| getTileCompWidth | Returns the width in pixels of the specified tile-component tile.
This default implementation returns the value of the source. (Inherited from CSJ2K.j2k.image.ImgDataAdapter) |
| initTileComp | Load options, length calculation type and termination type for each tile-component. |
| isReversible | (Inherited from CSJ2K.j2k.entropy.encoder.EntropyCoder) |
| nextTile | Overridden. 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. |
| precinctPartitionUsed | Overridden. Returns true if precinct partition is used for the specified component and tile, returns false otherwise. |
| setTile | Overridden. 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. |
Top
See Also