Class MultiResImgDataAdapter

  • All Implemented Interfaces:
    MultiResImgData
    Direct Known Subclasses:
    Dequantizer, EntropyDecoder, ROIDeScaler

    public abstract class MultiResImgDataAdapter
    extends Object
    implements MultiResImgData
    This class provides a default implementation for the methods of the 'MultiResImgData' interface. The default implementation consists just in returning the value of the source, where the source is another 'MultiResImgData' object.

    This abstract class can be used to facilitate the development of other classes that implement 'MultiResImgData'. For example a dequantizer can inherit from this class and all the trivial methods do not have to be reimplemented.

    If the default implementation of a method provided in this class does not suit a particular implementation of the 'MultiResImgData' interface, the method can be overriden to implement the proper behaviour.

    See Also:
    MultiResImgData
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected MultiResImgData mressrc
      The MultiResImgData source
      protected int tIdx
      Index of the current tile
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected MultiResImgDataAdapter​(MultiResImgData src)
      Instantiates the MultiResImgDataAdapter object specifying the MultiResImgData source.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getCompImgHeight​(int c, int rl)
      Returns the height in pixels of the specified component in the overall image, for the given resolution level.
      int getCompImgWidth​(int c, int rl)
      Returns the width in pixels of the specified component in the overall image, for the given resolution level.
      int getCompSubsX​(int c)
      Returns the component subsampling factor in the horizontal direction, for the specified component.
      int getCompSubsY​(int c)
      Returns the component subsampling factor in the vertical direction, for the specified component.
      int getImgHeight​(int rl)
      Returns the overall height of the image in pixels, for the given resolution level.
      int getImgULX​(int rl)
      Returns the horizontal coordinate of the image origin, the top-left corner, in the canvas system, on the reference grid at the specified resolution level.
      int getImgULY​(int rl)
      Returns the vertical coordinate of the image origin, the top-left corner, in the canvas system, on the reference grid at the specified resolution level.
      int getImgWidth​(int rl)
      Returns the overall width of the image in pixels, for the given resolution level.
      int getNomTileHeight()
      Returns the nominal tiles height
      int getNomTileWidth()
      Returns the nominal tiles width
      int getNumComps()
      Returns the number of components in the image.
      int getNumTiles()
      Returns the total number of tiles in the image.
      Point getNumTiles​(Point co)
      Returns the number of tiles in the horizontal and vertical directions.
      int getResULX​(int c, int rl)
      Returns the horizontal coordinate of the upper-left corner of the specified resolution level in the given component of the current tile.
      int getResULY​(int c, int rl)
      Returns the vertical coordinate of the upper-left corner of the specified resolution in the given component of the current tile.
      Point getTile​(Point co)
      Returns the indexes of the current tile.
      int getTileCompHeight​(int t, int c, int rl)
      Returns the height in pixels of the specified tile-component for the given resolution level.
      int getTileCompWidth​(int t, int c, int rl)
      Returns the width in pixels of the specified tile-component for the given resolution level.
      int getTileHeight​(int rl)
      Returns the overall height of the current tile in pixels, for the given resolution level.
      int getTileIdx()
      Returns the index of the current tile, relative to a standard scan-line order.
      int getTilePartULX()
      Returns the horizontal tile partition offset in the reference grid
      int getTilePartULY()
      Returns the vertical tile partition offset in the reference grid
      int getTileWidth​(int rl)
      Returns the overall width of the current tile in pixels, for the given resolution level.
      void nextTile()
      Advances to the next tile, in standard scan-line order (by rows then columns).
      void setTile​(int x, int y)
      Changes the current tile, given the new indexes.
    • Field Detail

      • tIdx

        protected int tIdx
        Index of the current tile
    • Constructor Detail

      • MultiResImgDataAdapter

        protected MultiResImgDataAdapter​(MultiResImgData src)
        Instantiates the MultiResImgDataAdapter object specifying the MultiResImgData source.
        Parameters:
        src - From where to obrtain the MultiResImgData values.
    • Method Detail

      • getTileWidth

        public int getTileWidth​(int rl)
        Returns 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.

        Specified by:
        getTileWidth in interface MultiResImgData
        Parameters:
        rl - The resolution level, from 0 to L.
        Returns:
        The total current tile's width in pixels.
      • getTileHeight

        public int getTileHeight​(int rl)
        Returns 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.

        Specified by:
        getTileHeight in interface MultiResImgData
        Parameters:
        rl - The resolution level, from 0 to L.
        Returns:
        The total current tile's height in pixels.
      • getImgWidth

        public int getImgWidth​(int rl)
        Returns 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.

        Specified by:
        getImgWidth in interface MultiResImgData
        Parameters:
        rl - The resolution level, from 0 to L.
        Returns:
        The total image's width in pixels.
      • getImgHeight

        public int getImgHeight​(int rl)
        Returns 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.

        Specified by:
        getImgHeight in interface MultiResImgData
        Parameters:
        rl - The resolution level, from 0 to L.
        Returns:
        The total image's height in pixels.
      • getNumComps

        public int getNumComps()
        Returns the number of components in the image.

        This default implementation returns the value of the source.

        Specified by:
        getNumComps in interface MultiResImgData
        Returns:
        The number of components in the image.
      • getCompSubsX

        public int getCompSubsX​(int c)
        Returns 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.

        Specified by:
        getCompSubsX in interface MultiResImgData
        Parameters:
        c - The index of the component (between 0 and N-1)
        Returns:
        The horizontal subsampling factor of component 'c'
        See Also:
        ImgData
      • getCompSubsY

        public int getCompSubsY​(int c)
        Returns 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.

        Specified by:
        getCompSubsY in interface MultiResImgData
        Parameters:
        c - The index of the component (between 0 and N-1)
        Returns:
        The vertical subsampling factor of component 'c'
        See Also:
        ImgData
      • getTileCompWidth

        public int getTileCompWidth​(int t,
                                    int c,
                                    int rl)
        Returns the width in pixels of the specified tile-component for the given resolution level.

        This default implementation returns the value of the source.

        Specified by:
        getTileCompWidth in interface MultiResImgData
        Parameters:
        t - Tile index.
        c - The index of the component, from 0 to N-1.
        rl - The resolution level, from 0 to L.
        Returns:
        The width in pixels of component c in tile t for resolution level rl.
      • getTileCompHeight

        public int getTileCompHeight​(int t,
                                     int c,
                                     int rl)
        Returns the height in pixels of the specified tile-component for the given resolution level.

        This default implementation returns the value of the source.

        Specified by:
        getTileCompHeight in interface MultiResImgData
        Parameters:
        t - The tile index.
        c - The index of the component, from 0 to N-1.
        rl - The resolution level, from 0 to L.
        Returns:
        The height in pixels of component c in tile t.
      • getCompImgWidth

        public int getCompImgWidth​(int c,
                                   int rl)
        Returns 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.

        Specified by:
        getCompImgWidth in interface MultiResImgData
        Parameters:
        c - The index of the component, from 0 to N-1.
        rl - The resolution level, from 0 to L.
        Returns:
        The width in pixels of component c in the overall image.
      • getCompImgHeight

        public int getCompImgHeight​(int c,
                                    int rl)
        Returns the height in pixels of the specified component in the overall image, for the given resolution level.

        This default implementation returns the value of the source.

        Specified by:
        getCompImgHeight in interface MultiResImgData
        Parameters:
        c - The index of the component, from 0 to N-1.
        rl - The resolution level, from 0 to L.
        Returns:
        The height in pixels of component c in the overall image.
      • setTile

        public void setTile​(int x,
                            int y)
        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.

        Specified by:
        setTile in interface MultiResImgData
        Parameters:
        x - The horizontal indexes the tile.
        y - The vertical indexes of the new tile.
      • nextTile

        public void nextTile()
        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 changes the tile in the source.

        Specified by:
        nextTile in interface MultiResImgData
      • getTile

        public Point getTile​(Point co)
        Returns 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.

        Specified by:
        getTile in interface MultiResImgData
        Parameters:
        co - If not null this object is used to return the information. If null a new one is created and returned.
        Returns:
        The current tile's indexes (vertical and horizontal indexes).
      • getTileIdx

        public int getTileIdx()
        Returns the index of the current tile, relative to a standard scan-line order.

        This default implementation returns the value of the source.

        Specified by:
        getTileIdx in interface MultiResImgData
        Returns:
        The current tile's index (starts at 0).
      • getResULX

        public int getResULX​(int c,
                             int rl)
        Returns 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.

        Specified by:
        getResULX in interface MultiResImgData
        Parameters:
        c - The component index.
        rl - The resolution level index.
      • getResULY

        public int getResULY​(int c,
                             int rl)
        Returns 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.

        Specified by:
        getResULY in interface MultiResImgData
        Parameters:
        c - The component index.
        rl - The resolution level index.
      • getTilePartULX

        public int getTilePartULX()
        Returns the horizontal tile partition offset in the reference grid
        Specified by:
        getTilePartULX in interface MultiResImgData
      • getTilePartULY

        public int getTilePartULY()
        Returns the vertical tile partition offset in the reference grid
        Specified by:
        getTilePartULY in interface MultiResImgData
      • getImgULX

        public int getImgULX​(int rl)
        Returns 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.

        Specified by:
        getImgULX in interface MultiResImgData
        Parameters:
        rl - The resolution level, from 0 to L.
        Returns:
        The horizontal coordinate of the image origin in the canvas system, on the reference grid.
      • getImgULY

        public int getImgULY​(int rl)
        Returns 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.

        Specified by:
        getImgULY in interface MultiResImgData
        Parameters:
        rl - The resolution level, from 0 to L.
        Returns:
        The vertical coordinate of the image origin in the canvas system, on the reference grid.
      • getNumTiles

        public Point getNumTiles​(Point co)
        Returns the number of tiles in the horizontal and vertical directions.

        This default implementation returns the value of the source.

        Specified by:
        getNumTiles in interface MultiResImgData
        Parameters:
        co - If not null this object is used to return the information. If null a new one is created and returned.
        Returns:
        The number of tiles in the horizontal (Point.x) and vertical (Point.y) directions.
      • getNumTiles

        public int getNumTiles()
        Returns the total number of tiles in the image.

        This default implementation returns the value of the source.

        Specified by:
        getNumTiles in interface MultiResImgData
        Returns:
        The total number of tiles in the image.