ComponentOne PdfViewer for WPF and Silverlight
C1.WPF.PdfViewer.4.6.2 Assembly / CSJ2K.j2k.codestream.reader Namespace / FileBitstreamReaderAgent Class
Fields Properties Methods


In This Topic
    FileBitstreamReaderAgent Class Members
    In This Topic

    The following tables list the members exposed by FileBitstreamReaderAgent.

    Public Constructors
     NameDescription
    Public ConstructorReads all tiles headers and keep offset of their first packet. Finally it calls the rate allocation method.  
    Top
    Public Fields
     NameDescription
    Public FieldReference to the PktDecoder instance  
    Top
    Public Properties
     NameDescription
    Public PropertyReturn the actual number of read bytes. (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public PropertyReturn the actual decoding rate in bits per pixel. (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public PropertyGets the reference to the CBlkInfo array  
    Public PropertyReturns the horizontal code-block partition origin. Allowable values are 0 and 1, nothing else. (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public PropertyReturns the vertical code-block partition origin. Allowable values are 0 and 1, nothing else. (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public PropertyReturns the image resolution level to reconstruct from the codestream. This value cannot be computed before every main and tile headers are read. (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public PropertyReturns the nominal tile height (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public PropertyReturns the nominal tile width (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public PropertyReturns the number of components in the image. (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public PropertyReturn the target number of read bytes. (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public PropertyReturn the target decoding rate in bits per pixel. (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public PropertyReturns the index of the current tile, relative to a standard scan-line order. (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public PropertyReturns the horizontal offset of tile partition (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public PropertyReturns the vertical offset of tile partition (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Top
    Public Methods
     NameDescription
    Public MethodOverridden. 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.

    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.

    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.

    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'.

    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.

     
    Public MethodReturns the height in pixels of the specified component in the overall image, for the given (component) resolution level.

    Note: Component resolution level indexes may differ from tile-component resolution index. They are indeed indexed starting from the lowest number of decomposition levels of same component of each tile.

    Example: For an image (2 tiles) with 1 component (tile 0 having 2 decomposition levels and tile 1 having 3 decomposition levels), the first tile(-component) has 3 resolution levels and the second one has 4 resolution levels, whereas the component has only 3 resolution levels available.

    (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public MethodReturns the width in pixels of the specified component in the overall image, for the given (component) resolution level.

    Note: Component resolution level indexes may differ from tile-component resolution index. They are indeed indexed starting from the lowest number of decomposition levels of same component of each tile.

    Example: For an image (2 tiles) with 1 component (tile 0 having 2 decomposition levels and tile 1 having 3 decomposition levels), the first tile(-component) has 3 resolution levels and the second one has 4 resolution levels, whereas the component has only 3 resolution levels available.

    (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public 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.codestream.reader.BitstreamReaderAgent)
    Public 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.codestream.reader.BitstreamReaderAgent)
    Public MethodReturns the overall height of the image in pixels, for the given resolution level. This is the image's height without accounting for any component subsampling or tiling.

    Note: Image resolution level indexes may differ from tile-component resolution index. They are indeed indexed starting from the lowest number of decomposition levels of each component of each tile.

    Example: For an image (1 tile) with 2 components (component 0 having 2 decomposition levels and component 1 having 3 decomposition levels), the first (tile-) component has 3 resolution levels and the second one has 4 resolution levels, whereas the image has only 3 resolution levels available.

    (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public MethodReturns the horizontal coordinate of the image origin, the top-left corner, in the canvas system, on the reference grid at the specified resolution level.

    Note: Image resolution level indexes may differ from tile-component resolution index. They are indeed indexed starting from the lowest number of decomposition levels of each component of each tile.

    Example: For an image (1 tile) with 2 components (component 0 having 2 decomposition levels and component 1 having 3 decomposition levels), the first (tile-) component has 3 resolution levels and the second one has 4 resolution levels, whereas the image has only 3 resolution levels available.

    (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public MethodReturns the vertical coordinate of the image origin, the top-left corner, in the canvas system, on the reference grid at the specified resolution level.

    Note: Image resolution level indexes may differ from tile-component resolution index. They are indeed indexed starting from the lowest number of decomposition levels of each component of each tile.

    Example: For an image (1 tile) with 2 components (component 0 having 2 decomposition levels and component 1 having 3 decomposition levels), the first (tile-) component has 3 resolution levels and the second one has 4 resolution levels, whereas the image has only 3 resolution levels available.

    (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public MethodReturns the overall width of the image in pixels, for the given (image) resolution level. This is the image's width without accounting for any component subsampling or tiling.

    Note: Image resolution level indexes may differ from tile-component resolution index. They are indeed indexed starting from the lowest number of decomposition levels of each component of each tile.

    Example: For an image (1 tile) with 2 components (component 0 having 2 decomposition levels and component 1 having 3 decomposition levels), the first (tile-) component has 3 resolution levels and the second one has 4 resolution levels, whereas the image has only 3 resolution levels available.

    (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public MethodReturns the number of tile-part found for a given tile  
    Public MethodOverloaded. Returns the number of tiles in the horizontal and vertical directions. (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public MethodReturns the precinct partition width for the specified tile-component and (tile-component) resolution level. (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public MethodReturns the precinct partition height for the specified tile-component and (tile-component) resolution level. (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public MethodReturns the horizontal coordinate of the upper-left corner of the specified resolution in the given component of the current tile. (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public MethodReturns the vertical coordinate of the upper-left corner of the specified component in the given component of the current tile. (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public MethodReturns the subband tree, for the specified tile-component. This method returns the root element of the subband tree structure, see Subband and SubbandSyn. The tree comprises all the available resolution levels.

    Note: this method is not able to return subband tree for a tile different than the current one.

    The number of magnitude bits ('magBits' member variable) for each subband is not initialized.

    (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public MethodReturns the indexes of the current tile. These are the horizontal and vertical indexes of the current tile. (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public MethodReturns the height in pixels of the specified tile-component for the given (tile-component) resolution level. (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public MethodReturns the width in pixels of the specified tile-component for the given (tile-component) resolution level. (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public MethodReturns the overall height of the current tile in pixels, for the given resolution level. This is the tile's height without accounting for any component subsampling.

    Note: Tile resolution level indexes may be different from tile-component resolution index. They are indeed indexed starting from the lowest number of decomposition levels of each component of the tile.

    For an image (1 tile) with 2 components (component 0 having 2 decomposition levels and component 1 having 3 decomposition levels), the first (tile-)component has 3 resolution levels and the second one has 4 resolution levels, whereas the tile has only 3 resolution levels available.

    (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public MethodReturns the overall width of the current tile in pixels for the given (tile) resolution level. This is the tile's width without accounting for any component subsampling.

    Note: Tile resolution level indexes may be different from tile-component resolution index. They are indeed indexed starting from the lowest number of decomposition levels of each component of the tile.

    For an image (1 tile) with 2 components (component 0 having 2 decomposition levels and component 1 having 3 decomposition levels), the first (tile-)component has 3 resolution levels and the second one has 4 resolution levels, whereas the tile has only 3 resolution levels available.

    (Inherited from CSJ2K.j2k.codestream.reader.BitstreamReaderAgent)
    Public MethodOverridden. Advances to the next tile, in standard scan-line order (by rows then columns). A NoNextElementException is thrown if the current tile is the last one (i.e. there is no next tile).  
    Public MethodOverridden. Changes the current tile, given the new indexes. An IllegalArgumentException is thrown if the indexes do not correspond to a valid tile.  
    Top
    See Also