C# Class CSJ2K.j2k.image.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.

Inheritance: CSJ2K.j2k.image.ImgDataAdapter, BlkImgDataSrc

Exibir arquivo Open project: cureos/csj2k Class Usage Examples

Public Methods

Method	Description
Tiler ( BlkImgDataSrc src, int ax, int ay, int px, int py, int nw, int nh ) : System	Constructs a new tiler with the specified 'BlkImgDataSrc' source, image origin, tiling origin and nominal tile size.
ToString ( ) : System.String	Returns a String object representing Tiler's informations
close ( ) : void	Closes the underlying file or network connection from where the image data is being read.
getCompData ( CSJ2K.j2k.image.DataBlk blk, int c ) : CSJ2K.j2k.image.DataBlk	Returns, in the blk argument, a block of image data containing the specifed rectangular area, in the specified component. The data is returned, as a copy of the internal data, therefore the returned data can be modified "in place". 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.
getCompULX ( int c ) : int	Returns the horizontal coordinate of the upper-left corner of the specified component in the current tile.
getCompULY ( int c ) : int	Returns the vertical coordinate of the upper-left corner of the specified component in the current tile.
getFixedPoint ( int c ) : int	Returns the position of the fixed point in the specified component. This is the position of the least significant integral (i.e. non-fractional) bit, which is equivalent to the number of fractional bits. For instance, for fixed-point values with 2 fractional bits, 2 is returned. For floating-point data this value does not apply and 0 should be returned. Position 0 is the position of the least significant bit in the data.
getInternCompData ( CSJ2K.j2k.image.DataBlk blk, int c ) : CSJ2K.j2k.image.DataBlk	Returns, in the blk argument, a block of image data containing the specifed rectangular area, in the specified component. The data is returned, as a reference to the internal data, if any, instead of as a copy, therefore the returned data should not be modified. 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.
getNumTiles ( Coord co ) : Coord	Returns the number of tiles in the horizontal and vertical directions.
getNumTiles ( ) : int	Returns the total number of tiles in the image.
getTile ( Coord co ) : Coord	Returns the horizontal and vertical indexes of the current tile.
getTileCompHeight ( int t, int c ) : int	Returns the height in pixels of the specified tile-component.
getTileCompWidth ( int t, int c ) : int	Returns the width in pixels of the specified tile-component.
getTilingOrigin ( Coord co ) : Coord	Returns the tiling origin, referred to as '(xt0siz,yt0siz)' in the codestream header (SIZ marker segment).
isOrigSigned ( int c ) : bool	Returns true if the data read was originally signed in the specified component, false if not.
nextTile ( ) : void	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).
setTile ( int x, int y ) : void	Changes the current tile, given the new tile indexes. An IllegalArgumentException is thrown if the coordinates do not correspond to a valid tile.

Method Details

Tiler() public method

Constructs a new tiler with the specified 'BlkImgDataSrc' source, image origin, tiling origin and nominal tile size.

If src is tiled or "canvased", or /// if the arguments do not satisfy the specified constraints. /// ///

public Tiler ( BlkImgDataSrc src, int ax, int ay, int px, int py, int nw, int nh ) : System
src	BlkImgDataSrc	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	int	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	int	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	int	The horizontal tiling origin, in the canvas system, on the /// reference grid. It must satisfy 'px<=ax'. /// ///
py	int	The vertical tiling origin, in the canvas system, on the /// reference grid. It must satisfy 'py<=ay'. /// ///
nw	int	The nominal tile width, on the reference grid. If 0 then /// there is no tiling in that direction. /// ///
nh	int	The nominal tile height, on the reference grid. If 0 then /// there is no tiling in that direction. /// ///
return	System

ToString() public method

Returns a String object representing Tiler's informations

public ToString ( ) : System.String
return	System.String

close() public method

Closes the underlying file or network connection from where the image data is being read.

If an I/O error occurs. ///

public close ( ) : void
return	void

getCompData() public method

Returns, in the blk argument, a block of image data containing the specifed rectangular area, in the specified component. The data is returned, as a copy of the internal data, therefore the returned data can be modified "in place".

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.

public getCompData ( CSJ2K.j2k.image.DataBlk blk, int c ) : CSJ2K.j2k.image.DataBlk
blk	CSJ2K.j2k.image.DataBlk	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. /// ///
c	int	The index of the component from which to get the data. /// ///
return	CSJ2K.j2k.image.DataBlk

getCompULX() public method

Returns the horizontal coordinate of the upper-left corner of the specified component in the current tile.

public getCompULX ( int c ) : int
c	int	The component index. /// ///
return	int

getCompULY() public method

Returns the vertical coordinate of the upper-left corner of the specified component in the current tile.

public getCompULY ( int c ) : int
c	int	The component index. /// ///
return	int

getFixedPoint() public method

Returns the position of the fixed point in the specified component. This is the position of the least significant integral (i.e. non-fractional) bit, which is equivalent to the number of fractional bits. For instance, for fixed-point values with 2 fractional bits, 2 is returned. For floating-point data this value does not apply and 0 should be returned. Position 0 is the position of the least significant bit in the data.

public getFixedPoint ( int c ) : int
c	int	The index of the component. /// ///
return	int

getInternCompData() public method

Returns, in the blk argument, a block of image data containing the specifed rectangular area, in the specified component. The data is returned, as a reference to the internal data, if any, instead of as a copy, therefore the returned data should not be modified.

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.

public getInternCompData ( CSJ2K.j2k.image.DataBlk blk, int c ) : CSJ2K.j2k.image.DataBlk
blk	CSJ2K.j2k.image.DataBlk	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	int	The index of the component from which to get the data. /// ///
return	CSJ2K.j2k.image.DataBlk

getNumTiles() public method

Returns the number of tiles in the horizontal and vertical directions.

public getNumTiles ( Coord co ) : Coord
co	Coord	If not null this object is used to return the information. If /// null a new one is created and returned. /// ///
return	Coord

getNumTiles() public method

Returns the total number of tiles in the image.

public getNumTiles ( ) : int
return	int

getTile() public method

Returns the horizontal and vertical indexes of the current tile.

public getTile ( Coord co ) : Coord
co	Coord	If not null this object is used to return the /// information. If null a new one is created and returned. /// ///
return	Coord

getTileCompHeight() public method

Returns the height in pixels of the specified tile-component.

public getTileCompHeight ( int t, int c ) : int
t	int	The tile index. /// ///
c	int	The index of the component, from 0 to N-1. /// ///
return	int

getTileCompWidth() public method

Returns the width in pixels of the specified tile-component.

public getTileCompWidth ( int t, int c ) : int
t	int	Tile index /// ///
c	int	The index of the component, from 0 to N-1. /// ///
return	int

getTilingOrigin() public method

Returns the tiling origin, referred to as '(xt0siz,yt0siz)' in the codestream header (SIZ marker segment).

public getTilingOrigin ( Coord co ) : Coord
co	Coord	If not null this object is used to return the information. If /// null a new one is created and returned. /// ///
return	Coord

isOrigSigned() public method

Returns true if the data read was originally signed in the specified component, false if not.

public isOrigSigned ( int c ) : bool
c	int	The index of the component, from 0 to C-1. /// ///
return	bool

nextTile() public method

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

public nextTile ( ) : void
return	void

setTile() public method

Changes the current tile, given the new tile indexes. An IllegalArgumentException is thrown if the coordinates do not correspond to a valid tile.

public setTile ( int x, int y ) : void
x	int	The horizontal index of the tile. /// ///
y	int	The vertical index of the new tile. /// ///
return	void