ComponentOne PDF for .NET
CSJ2K.j2k.entropy.encoder Namespace / StdEntropyCoder Class
Fields Properties Methods


In This Topic
    StdEntropyCoder Class Members
    In This Topic

    The following tables list the members exposed by StdEntropyCoder.

    Public Constructors
     NameDescription
    Public ConstructorInstantiates a new entropy coder engine, with the specified source of data, nominal block width and height.

    If the 'OPT_PRED_TERM' option is given then the MQ termination must be 'TERM_PRED_ER' or an exception is thrown.

     
    Top
    Public Fields
     NameDescription
    Public FieldBy-pass mode specifications  
    Public FieldCausal stripes specifications  
    Public FieldThe default value for the property in THREADS_PROP_NAME: 0  
    Public FieldThe length calculation specifications  
    Public FieldMQ reset specifications  
    Public FieldRegular termination specifications  
    Public FieldError resilience segment symbol use specifications  
    Public FieldThe increase in priority for the compressor threads, currently 3. The compressor threads will have a priority of THREADS_PRIORITY_INC more than the priority of the thread calling this class constructor. Used only in the multi-threaded implementation.  
    Public FieldThe Java system property name for the number of threads to use: jj2000.j2k.entropy.encoder.StdEntropyCoder.nthreads  
    Public FieldThe termination type specifications  
    Top
    Public Properties
     NameDescription
    Public PropertyReturns the horizontal offset of the code-block partition. Allowable values are 0 and 1, nothing else. (Inherited from CSJ2K.j2k.entropy.encoder.EntropyCoder)
    Public PropertyReturns the vertical offset of the code-block partition. Allowable values are 0 and 1, nothing else. (Inherited from CSJ2K.j2k.entropy.encoder.EntropyCoder)
    Public PropertyReturns the overall height of the image in pixels. This is the image's height without accounting for any component subsampling or tiling.

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.image.ImgDataAdapter)
    Public PropertyReturns the horizontal coordinate of the image origin, the top-left corner, in the canvas system, on the reference grid.

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.image.ImgDataAdapter)
    Public PropertyReturns the vertical coordinate of the image origin, the top-left corner, in the canvas system, on the reference grid.

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.image.ImgDataAdapter)
    Public PropertyReturns the overall width of the image in pixels. This is the image's width without accounting for any component subsampling or tiling.

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.image.ImgDataAdapter)
    Public PropertyReturns the nominal tiles height (Inherited from CSJ2K.j2k.image.ImgDataAdapter)
    Public PropertyReturns the nominal tiles width (Inherited from CSJ2K.j2k.image.ImgDataAdapter)
    Public PropertyReturns the number of components in the image.

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.image.ImgDataAdapter)
    Public 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.

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.image.ImgDataAdapter)
    Public PropertyReturns the index of the current tile, relative to a standard scan-line order.

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.image.ImgDataAdapter)
    Public PropertyReturns the horizontal tile partition offset in the reference grid (Inherited from CSJ2K.j2k.image.ImgDataAdapter)
    Public PropertyReturns the vertical tile offset in the reference grid (Inherited from CSJ2K.j2k.image.ImgDataAdapter)
    Public 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.

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.image.ImgDataAdapter)
    Top
    Public Methods
     NameDescription
    Public MethodReturns a reference to the root of subband tree structure representing the subband decomposition for the specified tile-component. (Inherited from CSJ2K.j2k.entropy.encoder.EntropyCoder)
    Public MethodOverridden. Returns the code-block height for the specified tile and component.  
    Public MethodOverridden. Returns the code-block width for the specified tile and component.  
    Public MethodReturns the height in pixels of the specified component in the overall image.

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.image.ImgDataAdapter)
    Public MethodReturns the width in pixels of the specified component in the overall image.

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.image.ImgDataAdapter)
    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.

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.image.ImgDataAdapter)
    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.

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.image.ImgDataAdapter)
    Public MethodReturns the horizontal coordinate of the upper-left corner of the specified component in the current tile.

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.image.ImgDataAdapter)
    Public MethodReturns the vertical coordinate of the upper-left corner of the specified component in the current tile.

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.image.ImgDataAdapter)
    Public MethodOverridden. Returns the next coded 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.

     
    Public Method (Inherited from CSJ2K.j2k.image.ImgDataAdapter)
    Public MethodOverloaded. Returns the number of tiles in the horizontal and vertical directions.

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.image.ImgDataAdapter)
    Public MethodOverridden. Returns the precinct partition width for the specified component, tile and resolution level.  
    Public MethodOverridden. Returns the precinct partition height for the specified component, tile and resolution level.  
    Public MethodReturns the indexes of the current tile. These are the horizontal and vertical indexes of the current tile.

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.image.ImgDataAdapter)
    Public MethodReturns the height in pixels of the specified tile-component.

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.image.ImgDataAdapter)
    Public MethodReturns the width in pixels of the specified tile-component tile.

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.image.ImgDataAdapter)
    Public MethodLoad options, length calculation type and termination type for each tile-component.  
    Public Method (Inherited from CSJ2K.j2k.entropy.encoder.EntropyCoder)
    Public MethodOverridden. Advances 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).

    This default implementation just advances to the next tile in the source.

     
    Public MethodOverridden. Returns true if precinct partition is used for the specified component and tile, returns false otherwise.  
    Public MethodOverridden. Changes the current tile, given the new indexes. An IllegalArgumentException is thrown if the indexes do not correspond to a valid tile.

    This default implementation just changes the tile in the source.

     
    Top
    See Also