|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjp2codec.image.ImgDataAdapter
jp2codec.image.Tiler
public class Tiler
This class places an image in the canvas coordinate system, tiles it, if so specified, and performs the coordinate conversions transparently. The source must be a 'BlkImgDataSrc' which is not tiled and has a the image origin at the canvas origin (i.e. it is not "canvased"), or an exception is thrown by the constructor. A tiled and "canvased" output is given through the 'BlkImgDataSrc' interface. See the 'ImgData' interface for a description of the canvas and tiling.
All tiles produced are rectangular, non-overlapping and their union covers all the image. However, the tiling may not be uniform, depending on the nominal tile size, tiling origin, component subsampling and other factors. Therefore it might not be assumed that all tiles are of the same width and height.
The nominal dimension of the tiles is the maximal one, in the reference grid. All the components of the image have the same number of tiles.
ImgData
,
BlkImgDataSrc
Field Summary |
---|
Fields inherited from class jp2codec.image.ImgDataAdapter |
---|
imgdatasrc, tIdx |
Constructor Summary | |
---|---|
Tiler(BlkImgDataSrc src,
int ax,
int ay,
int px,
int py,
int nw,
int nh)
Constructs a new tiler with the specified 'BlkImgDataSrc' source, image origin, tiling origin and nominal tile size. |
Method Summary | |
---|---|
DataBlk |
getCompData(DataBlk blk,
int n)
Returns, in the blk argument, a block of image data containing the specifed rectangular area, in the specified component. |
int |
getCompHeight(int c)
Returns the height in pixels of the specified component in the current tile. |
int |
getCompWidth(int c)
Returns the width in pixels of the specified component in the current tile. |
int |
getFixedPoint(int c)
Returns the position of the fixed point in the specified component. |
int |
getHeight()
Returns the overall height of the current tile 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. |
DataBlk |
getInternCompData(DataBlk blk,
int c)
Returns, in the blk argument, a block of image data containing the specifed rectangular area, in the specified component. |
int |
getNomTileHeight()
Returns the nominal width of the tiles in the reference grid. |
int |
getNomTileWidth()
Returns the nominal width of the tiles in the reference grid. |
int |
getNumTiles()
Returns the total number of tiles in the image. |
Coord |
getNumTiles(Coord co)
Returns the number of tiles in the horizontal and vertical directions. |
Coord |
getTile(Coord co)
Returns the horizontal and vertical indexes of the current tile. |
int |
getTileIdx()
Returns the index of the current tile, relative to a standard scan-line order. |
Coord |
getTileOff(Coord co,
int c)
Returns the horizontal and vertical offset of the upper-left corner of the current tile, in the specified component, relative to the canvas origin, in the component coordinates (not in the reference grid coordinates). |
Coord |
getTilingOrigin(Coord co)
Returns the tiling origin, refferred to as '(Px,Py)' in the 'ImgData' interface. |
int |
getULX(int c)
Returns the horizontal coordinate of the upper-left corner of the active tile, with respect to the canvas origin, in the component coordinates, for the specified component. |
int |
getULY(int c)
Returns the vertical coordinate of the upper-left corner of the active tile, with respect to the canvas origin, in the component coordinates, for the specified component. |
int |
getWidth()
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 tile indexes. |
java.lang.String |
toString()
Returns a String object representing Tiler's informations |
Methods inherited from class jp2codec.image.ImgDataAdapter |
---|
getCompImgHeight, getCompImgWidth, getCompSubsX, getCompSubsY, getImgHeight, getImgWidth, getNomRangeBits, getNumComps |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface jp2codec.image.ImgData |
---|
getCompImgHeight, getCompImgWidth, getCompSubsX, getCompSubsY, getImgHeight, getImgWidth, getNomRangeBits, getNumComps |
Constructor Detail |
---|
public Tiler(BlkImgDataSrc src, int ax, int ay, int px, int py, int nw, int nh)
It must be noted that 'ax' and 'bx' can not be chosen arbitrarily for multi component images with different component subsampling. This is because not all '(ax,bx)' yield the correct component dimensions (i.e. the component dimensions derived from '(ax,bx)' and the subsampling factors might not be the same as the true component dimensions). See the 'ImgData' interface for component width calculation from '(ax,bx)' and subsampling factors. This is checked by the constructor and an 'IllegalArgumentException' is thrown if an inconsistency occurs.
src
- The 'BlkImgDataSrc' source from where to get the image
data. It must not be tiled and the image origin must be at '(0,0)' on
its canvas.ax
- The horizontal coordinate of the image origin in the canvas
system, on the reference grid (i.e. the image's top-left corner in the
reference grid).ay
- The vertical coordinate of the image origin in the canvas
system, on the reference grid (i.e. the image's top-left corner in the
reference grid).px
- The horizontal tiling origin, in the canvas system, on the
reference grid. It must satisfy 'px<=ax'.py
- The vertical tiling origin, in the canvas system, on the
reference grid. It must satisfy 'py<=ay'.nw
- The nominal tile width, on the reference grid. If 0 then
there is no tiling in that direction.nh
- The nominal tile height, on the reference grid. If 0 then
there is no tiling in that direction.
java.lang.IllegalArgumentException
- If src is tiled or "canvased", or
if the arguments do not satisfy the specified constraints.Method Detail |
---|
public final int getWidth()
getWidth
in interface ImgData
getWidth
in class ImgDataAdapter
public final int getHeight()
getHeight
in interface ImgData
getHeight
in class ImgDataAdapter
public final int getCompWidth(int c)
getCompWidth
in interface ImgData
getCompWidth
in class ImgDataAdapter
c
- The index of the component, from 0 to N-1.
public final int getCompHeight(int c)
getCompHeight
in interface ImgData
getCompHeight
in class ImgDataAdapter
c
- The index of the component, from 0 to N-1.
public int getFixedPoint(int c)
getFixedPoint
in interface BlkImgDataSrc
c
- The index of the component.
public final DataBlk getInternCompData(DataBlk blk, int c)
The rectangular area to return is specified by the 'ulx', 'uly', 'w' and 'h' members of the 'blk' argument, relative to the current tile. These members are not modified by this method. The 'offset' and 'scanw' of the returned data can be arbitrary. See the 'DataBlk' class.
This method, in general, is more efficient than the 'getCompData()' method since it may not copy the data. However if the array of returned data is to be modified by the caller then the other method is probably preferable.
If the data array in blk is null, then a new one is created if necessary. The implementation of this interface may choose to return the same array or a new one, depending on what is more efficient. Therefore, the data array in blk prior to the method call should not be considered to contain the returned data, a new array may have been created. Instead, get the array from blk after the method has returned.
The returned data may have its 'progressive' attribute set. In this case the returned data is only an approximation of the "final" data.
getInternCompData
in interface BlkImgDataSrc
blk
- Its coordinates and dimensions specify the area to return,
relative to the current tile. Some fields in this object are modified
to return the data.c
- The index of the component from which to get the data.
getCompData(jp2codec.image.DataBlk, int)
public final DataBlk getCompData(DataBlk blk, int n)
The rectangular area to return is specified by the 'ulx', 'uly', 'w' and 'h' members of the 'blk' argument, relative to the current tile. These members are not modified by this method. The 'offset' of the returned data is 0, and the 'scanw' is the same as the block's width. See the 'DataBlk' class.
This method, in general, is less efficient than the 'getInternCompData()' method since, in general, it copies the data. However if the array of returned data is to be modified by the caller then this method is preferable.
If the data array in 'blk' is 'null', then a new one is created. If the data array is not 'null' then it is reused, and it must be large enough to contain the block's data. Otherwise an 'ArrayStoreException' or an 'IndexOutOfBoundsException' is thrown by the Java system.
The returned data may have its 'progressive' attribute set. In this case the returned data is only an approximation of the "final" data.
getCompData
in interface BlkImgDataSrc
blk
- Its coordinates and dimensions specify the area to return,
relative to the current tile. If it contains a non-null data array,
then it must be large enough. If it contains a null data array a new
one is created. Some fields in this object are modified to return the
data.n
- The index of the component from which to get the data.
getInternCompData(jp2codec.image.DataBlk, int)
public final void setTile(int x, int y)
setTile
in interface ImgData
setTile
in class ImgDataAdapter
x
- The horizontal index of the tile.y
- The vertical index of the new tile.public final void nextTile()
nextTile
in interface ImgData
nextTile
in class ImgDataAdapter
public final Coord getTile(Coord co)
getTile
in interface ImgData
getTile
in class ImgDataAdapter
co
- If not null this object is used to return the
information. If null a new one is created and returned.
public final int getTileIdx()
getTileIdx
in interface ImgData
getTileIdx
in class ImgDataAdapter
public final Coord getTileOff(Coord co, int c)
getTileOff
in interface ImgData
getTileOff
in class ImgDataAdapter
co
- If not null the object is used to return the values,
if null a new one is created and returned.c
- The index of the component (between 0 and N-1).
public final int getULX(int c)
getULX
in interface ImgData
getULX
in class ImgDataAdapter
c
- The index of the component (between 0 and N-1)
public final int getULY(int c)
getULY
in interface ImgData
getULY
in class ImgDataAdapter
c
- The index of the component (between 0 and N-1)
public final int getImgULX()
getImgULX
in interface ImgData
getImgULX
in class ImgDataAdapter
public final int getImgULY()
getImgULY
in interface ImgData
getImgULY
in class ImgDataAdapter
public final Coord getNumTiles(Coord co)
getNumTiles
in interface ImgData
getNumTiles
in class ImgDataAdapter
co
- If not null this object is used to return the information. If
null a new one is created and returned.
public final int getNumTiles()
getNumTiles
in interface ImgData
getNumTiles
in class ImgDataAdapter
public final int getNomTileWidth()
public final int getNomTileHeight()
public final Coord getTilingOrigin(Coord co)
co
- If not null this object is used to return the information. If
null a new one is created and returned.
ImgData
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |