Class ImgDataAdapter
- java.lang.Object
-
- jj2000.j2k.image.ImgDataAdapter
-
- All Implemented Interfaces:
ImgData
- Direct Known Subclasses:
EntropyCoder
,ForwardWT
,ForwCompTransf
,ImgDataConverter
,InvCompTransf
,PostCompRateAllocator
,Quantizer
,ROIScaler
,Tiler
public abstract class ImgDataAdapter extends Object implements ImgData
This class provides a default implementation of the methods in the 'ImgData' interface. The default implementation is just to return the value of the source, where the source is another 'ImgData' object.This abstract class can be used to facilitate the development of other classes that implement 'ImgData'. For example a YCbCr color transform can inherit from this class and all the trivial methods do not have to be re-implemented.
If the default implementation of a method provided in this class does not suit a particular implementation of the 'ImgData' interface, the method can be overridden to implement the proper behavior.
- See Also:
ImgData
-
-
Field Summary
Fields Modifier and Type Field Description protected ImgData
imgdatasrc
The ImgData sourceprotected int
tIdx
Index of the current tile
-
Constructor Summary
Constructors Modifier Constructor Description protected
ImgDataAdapter(ImgData src)
Instantiates the ImgDataAdapter object specifying the ImgData source.
-
Method Summary
All Methods Instance Methods Concrete 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 heightint
getNomTileWidth()
Returns the nominal tiles widthint
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 indexes 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 tile.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 gridint
getTilePartULY()
Returns the vertical tile offset in the reference gridint
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 indexes.
-
-
-
Field Detail
-
tIdx
protected int tIdx
Index of the current tile
-
imgdatasrc
protected ImgData imgdatasrc
The ImgData source
-
-
Constructor Detail
-
ImgDataAdapter
protected ImgDataAdapter(ImgData src)
Instantiates the ImgDataAdapter object specifying the ImgData source.- Parameters:
src
- From where to obtain all the ImgData values.
-
-
Method Detail
-
getTileWidth
public 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.This default implementation returns the value of the source.
- Specified by:
getTileWidth
in interfaceImgData
- Returns:
- The total current tile's width in pixels.
-
getTileHeight
public 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.This default implementation returns the value of the source.
- Specified by:
getTileHeight
in interfaceImgData
- Returns:
- The total current tile's height in pixels.
-
getNomTileWidth
public int getNomTileWidth()
Returns the nominal tiles width- Specified by:
getNomTileWidth
in interfaceImgData
-
getNomTileHeight
public int getNomTileHeight()
Returns the nominal tiles height- Specified by:
getNomTileHeight
in interfaceImgData
-
getImgWidth
public 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.This default implementation returns the value of the source.
- Specified by:
getImgWidth
in interfaceImgData
- Returns:
- The total image's width in pixels.
-
getImgHeight
public 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.This default implementation returns the value of the source.
- Specified by:
getImgHeight
in interfaceImgData
- 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 interfaceImgData
- 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 interfaceImgData
- 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 interfaceImgData
- 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)
Returns the width in pixels of the specified tile-component tile.This default implementation returns the value of the source.
- Specified by:
getTileCompWidth
in interfaceImgData
- Parameters:
t
- Tile indexc
- The index of the component, from 0 to N-1.- Returns:
- The width in pixels of component c in tilet.
-
getTileCompHeight
public int getTileCompHeight(int t, int c)
Returns the height in pixels of the specified tile-component.This default implementation returns the value of the source.
- Specified by:
getTileCompHeight
in interfaceImgData
- 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
public int getCompImgWidth(int c)
Returns the width in pixels of the specified component in the overall image.This default implementation returns the value of the source.
- Specified by:
getCompImgWidth
in interfaceImgData
- 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
public int getCompImgHeight(int c)
Returns the height in pixels of the specified component in the overall image.This default implementation returns the value of the source.
- Specified by:
getCompImgHeight
in interfaceImgData
- Parameters:
c
- The index of the component, from 0 to N-1.- Returns:
- The height in pixels of component c in the overall image.
-
getNomRangeBits
public 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.This default implementation returns the value of the source.
- Specified by:
getNomRangeBits
in interfaceImgData
- 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
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.
-
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 advances to the next tile in the source.
-
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.
-
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 interfaceImgData
- Returns:
- The current tile's index (starts at 0).
-
getCompULX
public int getCompULX(int c)
Returns 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.
- Specified by:
getCompULX
in interfaceImgData
- Parameters:
c
- The component index.
-
getCompULY
public int getCompULY(int c)
Returns 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.
- Specified by:
getCompULY
in interfaceImgData
- Parameters:
c
- The component index.
-
getTilePartULX
public int getTilePartULX()
Returns the horizontal tile partition offset in the reference grid- Specified by:
getTilePartULX
in interfaceImgData
-
getTilePartULY
public int getTilePartULY()
Returns the vertical tile offset in the reference grid- Specified by:
getTilePartULY
in interfaceImgData
-
getImgULX
public int getImgULX()
Returns 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.
-
getImgULY
public int getImgULY()
Returns 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.
-
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 interfaceImgData
- 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 interfaceImgData
- Returns:
- The total number of tiles in the image.
-
-