|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--jj2000.j2k.image.input.ImgReader
This is the generic interface to be implemented by all image file (or other resource) readers for different image file formats.
An ImgReader behaves as an ImgData object. Whenever image data is requested through the getInternCompData() or getCompData() methods, the image data will be read (if it is not buffered) and returned. Implementing classes should not buffer large amounts of data, so as to reduce memory usage.
This class sets the image origin to (0,0). All default implementations of the methods assume this.
This class provides default implementations of many methods. These default implementations assume that there is no tiling (i.e., the only tile is the entire image), that the image origin is (0,0) in the canvas system and that there is no component subsampling (all components are the same size), but they can be overloaded by the implementating class if need be.
Field Summary | |
protected int |
h
The height of the image |
protected int |
nc
The number of components in the image |
protected int |
w
The width of the image |
Constructor Summary | |
ImgReader()
|
Method Summary | |
abstract void |
close()
Closes the underlying file or network connection from where the image data is being read. |
int |
getCompHeight(int c)
Returns the height in pixels of the specified component in the current tile. |
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 |
getCompWidth(int n)
Returns the width in pixels of the specified component in the current tile. |
int |
getHeight()
Returns the overall height of the current tile in pixels, assuming there is no-tiling. |
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 |
getNumComps()
Returns the number of components in the image. |
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 coordinates 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). |
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 width of the current tile in pixels, assuming there is no-tiling. |
abstract boolean |
isOrigSigned(int c)
Returns true if the data read was originally signed in the specified component, false if not. |
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 coordinates. |
Methods inherited from class java.lang.Object |
|
Field Detail |
protected int w
protected int h
protected int nc
Constructor Detail |
public ImgReader()
Method Detail |
public abstract void close() throws java.io.IOException
public int getWidth()
public int getHeight()
public int getImgWidth()
public int getImgHeight()
public int getNumComps()
public int getCompSubsX(int c)
c
- The index of the component (between 0 and C-1)ImgData
public int getCompSubsY(int c)
c
- The index of the component (between 0 and C-1)ImgData
public int getCompWidth(int n)
c
- The index of the component, from 0 to C-1.public int getCompHeight(int c)
c
- The index of the component, from 0 to C-1.public int getCompImgWidth(int c)
c
- The index of the component, from 0 to C-1.public int getCompImgHeight(int c)
c
- The index of the component, from 0 to C-1.public void setTile(int x, int y)
x
- The horizontal coordinate of the tile.y
- The vertical coordinate of the new tile.public void nextTile()
public Coord getTile(Coord co)
co
- If not null this object is used to return the information. If
null a new one is created and returned.public int getTileIdx()
public Coord getTileOff(Coord co, int c)
This default implementation assumes no tiling and that the partitioning origin is the canvas origin, so (0,0) is always returned.
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 C-1)public int getULX(int c)
c
- The index of the component (between 0 and C-1)public int getULY(int c)
c
- The index of the component (between 0 and C-1)public int getImgULX()
public int getImgULY()
public Coord getNumTiles(Coord co)
co
- If not null this object is used to return the information. If
null a new one is created and returned.public int getNumTiles()
public abstract boolean isOrigSigned(int c)
c
- The index of the component, from 0 to C-1.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |