ComponentOne PDF for .NET
CSJ2K.j2k.wavelet.analysis Namespace / CBlkWTDataSrc Interface
Properties Methods

In This Topic
    CBlkWTDataSrc Interface Members
    In This Topic

    The following tables list the members exposed by CBlkWTDataSrc.

    Public Properties
     NameDescription
     PropertyReturns the horizontal offset of the code-block partition. Allowable values are 0 and 1, nothing else. (Inherited from CSJ2K.j2k.wavelet.analysis.ForwWTDataProps)
     PropertyReturns the vertical offset of the code-block partition. Allowable values are 0 and 1, nothing else. (Inherited from CSJ2K.j2k.wavelet.analysis.ForwWTDataProps)
     PropertyReturns the overall height of the image in pixels. This is the image's height without accounting for any component subsampling or tiling. (Inherited from CSJ2K.j2k.image.ImgData)
     PropertyReturns the horizontal coordinate of the image origin, the top-left corner, in the canvas system, on the reference grid. (Inherited from CSJ2K.j2k.image.ImgData)
     PropertyReturns the vertical coordinate of the image origin, the top-left corner, in the canvas system, on the reference grid. (Inherited from CSJ2K.j2k.image.ImgData)
     PropertyReturns the overall width of the image in pixels. This is the image's width without accounting for any component subsampling or tiling. (Inherited from CSJ2K.j2k.image.ImgData)
     PropertyReturns the nominal tiles height (Inherited from CSJ2K.j2k.image.ImgData)
     PropertyReturns the nominal tiles width (Inherited from CSJ2K.j2k.image.ImgData)
     PropertyReturns the number of components in the image. (Inherited from CSJ2K.j2k.image.ImgData)
     PropertyReturns the overall height of the current tile in pixels. This is the tile's height without accounting for any component subsampling. This is also referred as the reference grid height in the current tile. (Inherited from CSJ2K.j2k.image.ImgData)
     PropertyReturns the index of the current tile, relative to a standard scan-line order. (Inherited from CSJ2K.j2k.image.ImgData)
     PropertyReturns the horizontal tile partition offset in the reference grid (Inherited from CSJ2K.j2k.image.ImgData)
     PropertyReturns the vertical tile partition offset in the reference grid (Inherited from CSJ2K.j2k.image.ImgData)
     PropertyReturns the overall width of the current tile in pixels. This is the tile's width without accounting for any component subsampling. This is also referred as the reference grid width in the current tile. (Inherited from CSJ2K.j2k.image.ImgData)
    Top
    Public Methods
     NameDescription
     MethodReturns a reference to the root of subband tree structure representing the subband decomposition for the specified tile-component. (Inherited from CSJ2K.j2k.wavelet.analysis.ForwWTDataProps)
     MethodReturns the height in pixels of the specified component in the overall image. (Inherited from CSJ2K.j2k.image.ImgData)
     MethodReturns the width in pixels of the specified component in the overall image. (Inherited from CSJ2K.j2k.image.ImgData)
     MethodReturns 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. (Inherited from CSJ2K.j2k.image.ImgData)
     MethodReturns 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. (Inherited from CSJ2K.j2k.image.ImgData)
     MethodReturns the horizontal coordinate of the upper-left corner of the specified component in the current tile. (Inherited from CSJ2K.j2k.image.ImgData)
     MethodReturns the vertical coordinate of the upper-left corner of the specified component in the current tile. (Inherited from CSJ2K.j2k.image.ImgData)
     MethodReturn the data type of this CBlkWTDataSrc for the given component in the current tile. Its value should be either DataBlk.TYPE_INT or DataBlk.TYPE_FLOAT but can change according to the current tile-component.  
     MethodReturns the position of the fixed point in the specified component, or equivalently the number of fractional bits. This is the position of the least significant integral (i.e. non-fractional) bit, which is equivalent to the number of fractional bits. For instance, for fixed-point values with 2 fractional bits, 2 is returned. For floating-point data this value does not apply and 0 should be returned. Position 0 is the position of the least significant bit in the data.  
     MethodReturns the next 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. The 'offset' of the returned data is 0, and the 'scanw' is the same as the code-block width. The 'magbits' of the returned data is not set by this method and should be ignored. See the 'CBlkWTData' class.

    The 'ulx' and 'uly' members of the returned 'CBlkWTData' object contain the coordinates of the top-left corner of the block, with respect to the tile, not the subband.

     
     MethodReturns the next code-block in the current tile for the specified component. 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 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. The 'magbits' of the returned data is not set by this method and should be ignored. See the 'CBlkWTData' class.

    The 'ulx' and 'uly' members of the returned 'CBlkWTData' object contain the coordinates of the top-left corner of the block, with respect to the tile, not the subband.

     
     Method (Inherited from CSJ2K.j2k.image.ImgData)
     MethodReturns the number of tiles in the horizontal and vertical directions. (Inherited from CSJ2K.j2k.image.ImgData)
     MethodReturns the indixes of the current tile. These are the horizontal and vertical indexes of the current tile. (Inherited from CSJ2K.j2k.image.ImgData)
     MethodReturns the height in pixels of the specified tile-component. (Inherited from CSJ2K.j2k.image.ImgData)
     MethodReturns the width in pixels of the specified tile-component (Inherited from CSJ2K.j2k.image.ImgData)
     MethodReturns the reversibility of the given tile-component. Data is reversible when it is suitable for lossless and lossy-to-lossless compression. (Inherited from CSJ2K.j2k.wavelet.analysis.ForwWTDataProps)
     MethodAdvances 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). (Inherited from CSJ2K.j2k.image.ImgData)
     MethodChanges the current tile, given the new indices. An IllegalArgumentException is thrown if the coordinates do not correspond to a valid tile. (Inherited from CSJ2K.j2k.image.ImgData)
    Top
    See Also