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


In This Topic
    ROIScaler Class Members
    In This Topic

    The following tables list the members exposed by ROIScaler.

    Public Constructors
     NameDescription
    Public ConstructorConstructor of the ROI scaler, takes a Quantizer as source of data to scale.  
    Top
    Public Fields
     NameDescription
    Public FieldThe prefix for ROI Scaler options: 'R'  
    Top
    Public Properties
     NameDescription
    Public PropertyThis function returns the blockAligned flag  
    Public PropertyReturns the horizontal offset of the code-block partition. Allowable values are 0 and 1, nothing else.  
    Public PropertyReturns the vertical offset of the code-block partition. Allowable values are 0 and 1, nothing else.  
    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 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, the third one is a long description of what the parameter is and the fourth is its default value. 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 PropertyThis function returns the ROI mask generator.  
    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 Methodstatic (Shared in Visual Basic)Creates a ROIScaler object. The Quantizer is the source of data to scale.

    The ROI Scaler creates a ROIMaskGenerator depending on what ROI information is in the ParameterList. If only rectangular ROI are used, the fast mask generator for rectangular ROI can be used.

     
    Public MethodReturns a reference to the subband tree structure representing the subband decomposition for the specified tile-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 MethodThis function gets a datablk from the entropy coder. The sample sin the block, which consists of the quantized coefficients from the quantizer, are scaled by the values given for any ROIs specified.

    The function calls on a ROIMaskGenerator to get the mask for scaling the coefficients in the current block.

    The data returned by this method is a copy of the orignal data. Therfore 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 'CBlkWTData' class.

     
    Public MethodThis function gets a datablk from the entropy coder. The sample sin the block, which consists of the quantized coefficients from the quantizer, are scaled by the values given for any ROIs specified.

    The function calls on a ROIMaskGenerator to get the mask for scaling the coefficients in the current block.

     
    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 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 MethodSince ROI scaling is always a reversible operation, it calls isReversible() method of it source (the quantizer module).  
    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).  
    Public MethodOverridden. Changes the current tile, given the new indexes. An IllegalArgumentException is thrown if the indexes do not correspond to a valid tile.  
    Public MethodThis function returns the flag indicating if any ROI functionality used  
    Top
    See Also