getCodeBlock Method (CBlkWTDataSrcDec)

In This Topic

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

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.

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.

Syntax

Visual Basic
C#

'Declaration
 
Function getCodeBlock( _
   ByVal c As Integer, _
   ByVal m As Integer, _
   ByVal n As Integer, _
   ByVal sb As SubbandSyn, _
   ByVal cblk As DataBlk _
) As DataBlk

DataBlk getCodeBlock( 
   int c,
   int m,
   int n,
   SubbandSyn sb,
   DataBlk cblk
)

Parameters

c: The component for which to return the next code-block.
m: The vertical index of the code-block to return, in the specified subband.
n: The horizontal index of the code-block to return, in the specified subband.
sb: The subband in which the code-block to return is.
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.

Return Value

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

Reference

CBlkWTDataSrcDec Interface
CBlkWTDataSrcDec Members