ComponentOne PdfViewer for WPF and Silverlight
C1.WPF.PdfViewer.4.6.2 Assembly / CSJ2K.j2k.roi Namespace / ROIDeScaler Class
Fields Properties Methods


In This Topic
    ROIDeScaler Class Members
    In This Topic

    The following tables list the members exposed by ROIDeScaler.

    Public Constructors
     NameDescription
    Public ConstructorConstructor of the ROI descaler, takes EntropyDEcoder as source of data to de-scale.  
    Top
    Public Fields
     NameDescription
    Public FieldThe prefix for ROI decoder options: 'R'  
    Top
    Public Properties
     NameDescription
    Public PropertyReturns the horizontal code-block partition origin. Allowable values are 0 and 1, nothing else.  
    Public PropertyReturns the vertical code-block partition origin. Allowable values are 0 and 1, nothing else.  
    Public PropertyReturns the nominal tiles height (Inherited from CSJ2K.j2k.wavelet.synthesis.MultiResImgDataAdapter)
    Public PropertyReturns the nominal tiles width (Inherited from CSJ2K.j2k.wavelet.synthesis.MultiResImgDataAdapter)
    Public PropertyReturns the number of components in the image.

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.wavelet.synthesis.MultiResImgDataAdapter)
    Public Propertystatic (Shared in Visual Basic)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.  
    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.wavelet.synthesis.MultiResImgDataAdapter)
    Public PropertyReturns the horizontal tile partition offset in the reference grid (Inherited from CSJ2K.j2k.wavelet.synthesis.MultiResImgDataAdapter)
    Public PropertyReturns the vertical tile partition offset in the reference grid (Inherited from CSJ2K.j2k.wavelet.synthesis.MultiResImgDataAdapter)
    Top
    Public Methods
     NameDescription
    Public Methodstatic (Shared in Visual Basic)Creates a ROIDeScaler object. The information needed to create the object is the Entropy decoder used and the parameters.  
    Public MethodReturns the specified code-block in the current tile for the specified component, as a copy (see below).

    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.

    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.

    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.

     
    Public Method (Inherited from CSJ2K.j2k.wavelet.synthesis.MultiResImgDataAdapter)
    Public MethodReturns the width in pixels of the specified component in the overall image, for the given resolution level.

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.wavelet.synthesis.MultiResImgDataAdapter)
    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.wavelet.synthesis.MultiResImgDataAdapter)
    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.wavelet.synthesis.MultiResImgDataAdapter)
    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.

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.wavelet.synthesis.MultiResImgDataAdapter)
    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.

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.wavelet.synthesis.MultiResImgDataAdapter)
    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.

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.wavelet.synthesis.MultiResImgDataAdapter)
    Public MethodReturns the overall width of the image in pixels, for the given resolution level. 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.wavelet.synthesis.MultiResImgDataAdapter)
    Public MethodReturns the specified code-block in the current tile for the specified component (as a reference or copy).

    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.

    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.

    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.

     
    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.wavelet.synthesis.MultiResImgDataAdapter)
    Public MethodReturns the horizontal coordinate of the upper-left corner of the specified resolution level in the given component of the current tile.

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.wavelet.synthesis.MultiResImgDataAdapter)
    Public MethodReturns the vertical coordinate of the upper-left corner of the specified resolution in the given component of the current tile.

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.wavelet.synthesis.MultiResImgDataAdapter)
    Public MethodOverridden.   
    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.wavelet.synthesis.MultiResImgDataAdapter)
    Public MethodReturns the height in pixels of the specified tile-component for the given resolution level.

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.wavelet.synthesis.MultiResImgDataAdapter)
    Public MethodReturns the width in pixels of the specified tile-component for the given resolution level.

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.wavelet.synthesis.MultiResImgDataAdapter)
    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.

    This default implementation returns the value of the source.

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

    This default implementation returns the value of the source.

    (Inherited from CSJ2K.j2k.wavelet.synthesis.MultiResImgDataAdapter)
    Public 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).

    This default implementation just changes the tile in the source.

    (Inherited from CSJ2K.j2k.wavelet.synthesis.MultiResImgDataAdapter)
    Public MethodChanges 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.

    (Inherited from CSJ2K.j2k.wavelet.synthesis.MultiResImgDataAdapter)
    Top
    See Also