[]
        
(Showing Draft Content)

CSJ2K.j2k.entropy.decoder.StdEntropyDecoder.getCodeBlock

getCodeBlock Method

getCodeBlock(int, int, int, SubbandSyn, DataBlk)

Returns the specified code-block in the current tile for the specified component, as a copy (see below).

       <p>The returned code-block may be progressive, which is indicated by
       the 'progressive' variable of the returned 'DataBlk' object. If a
       code-block is progressive it means that in a later request to this
       method for the same code-block it is possible to retrieve data which is
       a better approximation, since meanwhile more data to decode for the
       code-block could have been received. If the code-block is not
       progressive then later calls to this method for the same code-block
       will return the exact same data values.</p><p>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. The 'offset' of the returned data is
       0, and the 'scanw' is the same as the code-block width. See the
       'DataBlk' class.</p><p>The 'ulx' and 'uly' members of the returned 'DataBlk' object contain
       the coordinates of the top-left corner of the block, with respect to
       the tile, not the subband.</p>
Declaration
public override DataBlk getCodeBlock(int c, int m, int n, SubbandSyn sb, DataBlk cblk)
Parameters
Type Name Description
int c

The component for which to return the next code-block.

int m

The vertical index of the code-block to return, in the specified subband.

int n

The horizontal index of the code-block to return, in the specified subband.

SubbandSyn sb

The subband in which the code-block to return is.

DataBlk cblk

If non-null this object will be used to return the new code-block. If null a new one will be allocated and returned. If the "data" array of the object is non-null it will be reused, if possible, to return the data.

Returns
Type Description
DataBlk

The next code-block in the current tile for component 'n', or null if all code-blocks for the current tile have been returned.

Overrides
See Also