[]
        
(Showing Draft Content)

CSJ2K.j2k.roi.ROIDeScaler

ROIDeScaler Class

This class takes care of the de-scaling of ROI coefficients. The de-scaler works on a tile basis and any mask that is generated is for the current mask only

       <p>Default implementations of the methods in 'MultiResImgData' are provided
       through the 'MultiResImgDataAdapter' abstract class.</p><p>Sign-magnitude representation is used (instead of two's complement) for
       the output data. The most significant bit is used for the sign (0 if
       positive, 1 if negative). Then the magnitude of the quantized coefficient
       is stored in the next most significat bits. The most significant magnitude
       bit corresponds to the most significant bit-plane and so on.</p>
Inheritance
ROIDeScaler
Namespace: CSJ2K.j2k.roi
Assembly: C1.WPF.PdfViewer.4.6.2.dll
Syntax
public class ROIDeScaler : MultiResImgDataAdapter, CBlkQuantDataSrcDec, InvWTData, MultiResImgData

Constructors

Name Description
ROIDeScaler(CBlkQuantDataSrcDec, MaxShiftSpec)

Constructor of the ROI descaler, takes EntropyDEcoder as source of data to de-scale.

Fields

Name Description
OPT_PREFIX

The prefix for ROI decoder options: 'R'

Properties

Name Description
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.

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.

Methods

Name Description
createInstance(CBlkQuantDataSrcDec, ParameterList, DecoderSpecs)

Creates a ROIDeScaler object. The information needed to create the object is the Entropy decoder used and the parameters.

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>
getInternCodeBlock(int, int, int, SubbandSyn, DataBlk)

Returns the specified code-block in the current tile for the specified component (as a reference or copy).

       <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 can be the data in the internal
       buffer of this object, if any, and thus can not be modified by the
       caller. The 'offset' and 'scanw' of the returned data can be
       arbitrary. 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>
getSynSubbandTree(int, int)

Returns the specified synthesis subband tree