| java.lang.Object
 jj2000.j2k.image.input.ImgReader
All known Subclasses: jj2000.j2k.image.input.ImgReaderPGM,
| ImgReader | | abstract public class ImgReader implements BlkImgDataSrc(Code) | | 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
| | protected int | nc
| | protected int | w
|
| Method Summary | |
| abstract public void | close()
Closes the underlying file or network connection from where the
image data is being read. | | public int | getCompImgHeight(int c)
Returns the height in pixels of the specified component in the overall
image. | | public int | getCompImgWidth(int c)
Returns the width in pixels of the specified component in the overall
image. | | public int | getCompSubsX(int c)
Returns the component subsampling factor in the horizontal direction,
for the specified component. | | public int | getCompSubsY(int c)
Returns the component subsampling factor in the vertical direction, for
the specified component. | | public int | getCompULX(int c)
Returns the horizontal coordinate of the upper-left corner of the
specified component in the current tile. | | public int | getCompULY(int c)
Returns the vertical coordinate of the upper-left corner of the
specified component in the current tile. | | public int | getImgHeight()
Returns the overall height of the image in pixels. | | public int | getImgULX()
Returns the horizontal coordinate of the image origin, the top-left
corner, in the canvas system, on the reference grid. | | public int | getImgULY()
Returns the vertical coordinate of the image origin, the top-left
corner, in the canvas system, on the reference grid. | | public int | getImgWidth()
Returns the overall width of the image in pixels. | | public int | getNomTileHeight()
| | public int | getNomTileWidth()
| | public int | getNumComps()
Returns the number of components in the image. | | public Point | getNumTiles(Point co)
Returns the number of tiles in the horizontal and vertical
directions. | | public int | getNumTiles()
Returns the total number of tiles in the image. | | public Point | getTile(Point co)
Returns the coordinates of the current tile. | | public int | getTileCompHeight(int t, int c)
Returns the height in pixels of the specified tile-component. | | public int | getTileCompWidth(int t, int c)
Returns the width in pixels of the specified tile-component. | | public int | getTileHeight()
Returns the overall height of the current tile in pixels, assuming
there is no-tiling. | | public int | getTileIdx()
Returns the index of the current tile, relative to a standard scan-line
order. | | public int | getTilePartULX()
| | public int | getTilePartULY()
| | public int | getTileWidth()
Returns the width of the current tile in pixels, assuming there is
no-tiling. | | abstract public boolean | isOrigSigned(int c)
Returns true if the data read was originally signed in the specified
component, false if not.
Parameters:
c - The index of the component, from 0 to C-1. | | public void | nextTile()
Advances to the next tile, in standard scan-line order (by rows then
columns). | | public void | setTile(int x, int y)
Changes the current tile, given the new coordinates. |
| h | | protected int h(Code) | | The height of the image
|
| nc | | protected int nc(Code) | | The number of components in the image
|
| w | | protected int w(Code) | | The width of the image
|
| close | | abstract public void close() throws IOException(Code) | | Closes the underlying file or network connection from where the
image data is being read.
exception:
IOException - If an I/O error occurs. |
| getCompImgHeight | | public int getCompImgHeight(int c)(Code) | | Returns the height in pixels of the specified component in the overall
image. This default implementation assumes no component, or component,
subsampling (i.e. all components have the same dimensions in pixels).
Parameters:
c - The index of the component, from 0 to C-1. The height in pixels of component c in the overallimage. |
| getCompImgWidth | | public int getCompImgWidth(int c)(Code) | | Returns the width in pixels of the specified component in the overall
image. This default implementation assumes no component, or component,
subsampling (i.e. all components have the same dimensions in pixels).
Parameters:
c - The index of the component, from 0 to C-1. The width in pixels of component c in the overallimage. |
| getCompSubsX | | public int getCompSubsX(int c)(Code) | | 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 C-1) The horizontal subsampling factor of component 'c'
See Also: jj2000.j2k.image.ImgData |
| getCompSubsY | | public int getCompSubsY(int c)(Code) | | 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 C-1) The vertical subsampling factor of component 'c'
See Also: jj2000.j2k.image.ImgData |
| getCompULX | | public int getCompULX(int c)(Code) | | Returns the horizontal coordinate of the upper-left corner of the
specified component in the current tile.
Parameters:
c - The component index. |
| getCompULY | | public int getCompULY(int c)(Code) | | Returns the vertical coordinate of the upper-left corner of the
specified component in the current tile.
Parameters:
c - The component index. |
| getImgHeight | | public int getImgHeight()(Code) | | Returns the overall height of the image in pixels. This is the image's
height without accounting for any component subsampling or tiling. The
value of h is returned.
The total image's height in pixels. |
| getImgULX | | public int getImgULX()(Code) | | Returns the horizontal coordinate of the image origin, the top-left
corner, in the canvas system, on the reference grid.
The horizontal coordinate of the image origin in the canvassystem, on the reference grid. |
| getImgULY | | public int getImgULY()(Code) | | Returns the vertical coordinate of the image origin, the top-left
corner, in the canvas system, on the reference grid.
The vertical coordinate of the image origin in the canvassystem, on the reference grid. |
| getImgWidth | | public int getImgWidth()(Code) | | Returns the overall width of the image in pixels. This is the image's
width without accounting for any component subsampling or tiling. The
value of w is returned.
The total image's width in pixels. |
| getNomTileHeight | | public int getNomTileHeight()(Code) | | Returns the nominal tiles height
|
| getNomTileWidth | | public int getNomTileWidth()(Code) | | Returns the nominal tiles width
|
| getNumComps | | public int getNumComps()(Code) | | Returns the number of components in the image. The value of nc
is returned.
The number of components in the image. |
| getNumTiles | | public Point getNumTiles(Point co)(Code) | | Returns the number of tiles in the horizontal and vertical
directions. This default implementation assumes no tiling, so (1,1) is
always returned.
Parameters:
co - If not null this object is used to return the information. Ifnull a new one is created and returned. The number of tiles in the horizontal (Point.x) and vertical(Point.y) directions. |
| getNumTiles | | public int getNumTiles()(Code) | | Returns the total number of tiles in the image. This default
implementation assumes no tiling, so 1 is always returned.
The total number of tiles in the image. |
| getTile | | public Point getTile(Point co)(Code) | | Returns the coordinates of the current tile. This default
implementation assumes no-tiling, so (0,0) is returned.
Parameters:
co - If not null this object is used to return the information. Ifnull a new one is created and returned. The current tile's coordinates. |
| getTileCompHeight | | public int getTileCompHeight(int t, int c)(Code) | | Returns the height in pixels of the specified tile-component. This
default implementation assumes no tiling and no component subsampling
(i.e., all components, or components, have the same dimensions in
pixels).
Parameters:
t - The tile index
Parameters:
c - The index of the component, from 0 to C-1. The height in pixels of component c in tilet. |
| getTileCompWidth | | public int getTileCompWidth(int t, int c)(Code) | | Returns the width in pixels of the specified tile-component. This
default implementation assumes no tiling and no component subsampling
(i.e., all components, or components, have the same dimensions in
pixels).
Parameters:
t - Tile index
Parameters:
c - The index of the component, from 0 to C-1. The width in pixels of component c in tilet. |
| getTileHeight | | public int getTileHeight()(Code) | | Returns the overall height of the current tile in pixels, assuming
there is no-tiling. Since no-tiling is assumed this is the same as the
width of the image. The value of h is returned.
The total image height in pixels. |
| getTileIdx | | public int getTileIdx()(Code) | | Returns the index of the current tile, relative to a standard scan-line
order. This default implementations assumes no tiling, so 0 is always
returned.
The current tile's index (starts at 0). |
| getTilePartULX | | public int getTilePartULX()(Code) | | Returns the horizontal tile partition offset in the reference grid
|
| getTilePartULY | | public int getTilePartULY()(Code) | | Returns the vertical tile partition offset in the reference grid
|
| getTileWidth | | public int getTileWidth()(Code) | | Returns the width of the current tile in pixels, assuming there is
no-tiling. Since no-tiling is assumed this is the same as the width of
the image. The value of w is returned.
The total image width in pixels. |
| isOrigSigned | | abstract public boolean isOrigSigned(int c)(Code) | | Returns true if the data read was originally signed in the specified
component, false if not.
Parameters:
c - The index of the component, from 0 to C-1. true if the data was originally signed, false if not. |
| nextTile | | public void nextTile()(Code) | | Advances to the next tile, in standard scan-line order (by rows then
columns). A NoNextElementException is thrown if the current tile is the
last one (i.e. there is no next tile). This default implementation
assumes no tiling, so NoNextElementException() is always thrown.
|
| setTile | | public void setTile(int x, int y)(Code) | | Changes the current tile, given the new coordinates. An
IllegalArgumentException is thrown if the coordinates do not correspond
to a valid tile. This default implementation assumes no tiling so the
only valid arguments are x=0, y=0.
Parameters:
x - The horizontal coordinate of the tile.
Parameters:
y - The vertical coordinate of the new tile. |
|
|