dotnet-framework-api
- C1.WPF.PdfViewer.4.6.2 Assembly

CSJ2K.j2k.codestream.reader.FileBitstreamReaderAgent.getCodeBlock

getCodeBlock Method

getCodeBlock(int, int, int, SubbandSyn, int, int, DecLyrdCBlk)

Returns the specified coded code-block, for the specified component, in the current tile. The first layer to return is indicated by 'fl'. The number of layers that is returned depends on 'nl' and the amount of available data.

       <p>The argument 'fl' is to be used by subsequent calls to this method
       for the same code-block. In this way supplemental data can be retrieved
       at a later time. The fact that data from more than one layer can be
       returned means that several packets from the same code-block, of the
       same component, and the same tile, have been concatenated.</p><p>The returned compressed code-block can have its progressive
       attribute set. If this attribute is set it means that more data can be
       obtained by subsequent calls to this method (subject to transmission
       delays, etc). If the progressive attribute is not set it means that the
       returned data is all the data that can be obtained for the specified
       code-block.</p><p>The compressed code-block is uniquely specified by the current tile,
       the component (identified by 'c'), the subband (indentified by 'sb')
       and the code-block vertical and horizontal indexes 'n' and 'm'.</p><p>The 'ulx' and 'uly' members of the returned 'DecLyrdCBlk' object
       contain the coordinates of the top-left corner of the block, with
       respect to the tile, not the subband.</p>

Declaration

public override DecLyrdCBlk getCodeBlock(int c, int m, int n, SubbandSyn sb, int fl, int nl, DecLyrdCBlk ccb)

Parameters

Type	Name	Description
int	c	The index of the component, from 0 to N-1.
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 whic the requested code-block is.
int	fl	The first layer to return.
int	nl	The number of layers to return, if negative all available layers are returned, starting at 'fl'.
DecLyrdCBlk	ccb	If not null this object is used to return the compressed code-block. If null a new object is created and returned. If the data array in ccb is not null then it can be reused to return the compressed data.

Returns

Type	Description
DecLyrdCBlk	The compressed code-block, with a certain number of layers determined by the available data and 'nl'.

Overrides

BitstreamReaderAgent.getCodeBlock(int, int, int, SubbandSyn, int, int, DecLyrdCBlk)