Interface ImgData

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int getCompImgHeight​(int c)
      Returns the height in pixels of the specified component in the overall image.
      int getCompImgWidth​(int c)
      Returns the width in pixels of the specified component in the overall image.
      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 getCompULX​(int c)
      Returns the horizontal coordinate of the upper-left corner of the specified component in the current tile.
      int getCompULY​(int c)
      Returns the vertical coordinate of the upper-left corner of the specified component in the current tile.
      int getImgHeight()
      Returns the overall height of the image in pixels.
      int getImgULX()
      Returns the horizontal coordinate of the image origin, the top-left corner, in the canvas system, on the reference grid.
      int getImgULY()
      Returns the vertical coordinate of the image origin, the top-left corner, in the canvas system, on the reference grid.
      int getImgWidth()
      Returns the overall width of the image in pixels.
      int getNomRangeBits​(int c)
      Returns the number of bits, referred to as the "range bits", corresponding to the nominal range of the image data in the specified component.
      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.
      Point getTile​(Point co)
      Returns the indixes of the current tile.
      int getTileCompHeight​(int t, int c)
      Returns the height in pixels of the specified tile-component.
      int getTileCompWidth​(int t, int c)
      Returns the width in pixels of the specified tile-component
      int getTileHeight()
      Returns the overall height of the current tile in pixels.
      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()
      Returns the overall width of the current tile in pixels.
      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 indices.
    • Method Detail

      • getTileWidth

        int getTileWidth()
        Returns 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.
        Returns:
        The total current tile's width in pixels.
      • getTileHeight

        int getTileHeight()
        Returns 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.
        Returns:
        The total current tile's height in pixels.
      • getNomTileWidth

        int getNomTileWidth()
        Returns the nominal tiles width
      • getNomTileHeight

        int getNomTileHeight()
        Returns the nominal tiles height
      • getImgWidth

        int getImgWidth()
        Returns the overall width of the image in pixels. This is the image's width without accounting for any component subsampling or tiling.
        Returns:
        The total image's width in pixels.
      • getImgHeight

        int getImgHeight()
        Returns the overall height of the image in pixels. This is the image's height without accounting for any component subsampling or tiling.
        Returns:
        The total image's height in pixels.
      • getNumComps

        int getNumComps()
        Returns the number of components in the image.
        Returns:
        The number of components in the image.
      • getCompSubsX

        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.
        Parameters:
        c - The index of the component (between 0 and N-1)
        Returns:
        The horizontal subsampling factor of component 'c'
        See Also:
        ImgData
      • getCompSubsY

        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.
        Parameters:
        c - The index of the component (between 0 and N-1)
        Returns:
        The vertical subsampling factor of component 'c'
        See Also:
        ImgData
      • getTileCompWidth

        int getTileCompWidth​(int t,
                             int c)
        Returns the width in pixels of the specified tile-component
        Parameters:
        t - Tile index
        c - The index of the component, from 0 to N-1.
        Returns:
        The width in pixels of component c in tilet.
      • getTileCompHeight

        int getTileCompHeight​(int t,
                              int c)
        Returns the height in pixels of the specified tile-component.
        Parameters:
        t - The tile index.
        c - The index of the component, from 0 to N-1.
        Returns:
        The height in pixels of component c in tile t.
      • getCompImgWidth

        int getCompImgWidth​(int c)
        Returns the width in pixels of the specified component in the overall image.
        Parameters:
        c - The index of the component, from 0 to N-1.
        Returns:
        The width in pixels of component c in the overall image.
      • getCompImgHeight

        int getCompImgHeight​(int c)
        Returns the height in pixels of the specified component in the overall image.
        Parameters:
        c - The index of the component, from 0 to N-1.
        Returns:
        The height in pixels of component n in the overall image.
      • getNomRangeBits

        int getNomRangeBits​(int c)
        Returns the number of bits, referred to as the "range bits", corresponding to the nominal range of the image data in the specified component. If this number is n then for unsigned data the nominal range is between 0 and 2^b-1, and for signed data it is between -2^(b-1) and 2^(b-1)-1. In the case of transformed data which is not in the image domain (e.g., wavelet coefficients), this method returns the "range bits" of the image data that generated the coefficients.
        Parameters:
        c - The index of the component.
        Returns:
        The number of bits corresponding to the nominal range of the image data (in the image domain).
      • setTile

        void setTile​(int x,
                     int y)
        Changes the current tile, given the new indices. An IllegalArgumentException is thrown if the coordinates do not correspond to a valid tile.
        Parameters:
        x - The horizontal index of the tile.
        y - The vertical index of the new tile.
      • nextTile

        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).
      • getTile

        Point getTile​(Point co)
        Returns the indixes of the current tile. These are the horizontal and vertical indexes of the current tile.
        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 indices (vertical and horizontal indexes).
      • getTileIdx

        int getTileIdx()
        Returns the index of the current tile, relative to a standard scan-line order.
        Returns:
        The current tile's index (starts at 0).
      • getTilePartULX

        int getTilePartULX()
        Returns the horizontal tile partition offset in the reference grid
      • getTilePartULY

        int getTilePartULY()
        Returns the vertical tile partition offset in the reference grid
      • getCompULX

        int getCompULX​(int c)
        Returns the horizontal coordinate of the upper-left corner of the specified component in the current tile.
        Parameters:
        c - The index of the component.
      • getCompULY

        int getCompULY​(int c)
        Returns the vertical coordinate of the upper-left corner of the specified component in the current tile.
        Parameters:
        c - The index of the component.
      • getImgULX

        int getImgULX()
        Returns the horizontal coordinate of the image origin, the top-left corner, in the canvas system, on the reference grid.
        Returns:
        The horizontal coordinate of the image origin in the canvas system, on the reference grid.
      • getImgULY

        int getImgULY()
        Returns the vertical coordinate of the image origin, the top-left corner, in the canvas system, on the reference grid.
        Returns:
        The vertical coordinate of the image origin in the canvas system, on the reference grid.
      • getNumTiles

        Point getNumTiles​(Point co)
        Returns the number of tiles in the horizontal and vertical directions.
        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

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