IlvRasterProperties (Rogue Wave JViews 9.1 API)

java.lang.Object
- ilog.views.maps.raster.IlvRasterProperties

All Implemented Interfaces:

IlvPersistentObject
```
public class IlvRasterProperties
extends Object
implements IlvPersistentObject
```
Class gathering all the information about the raster image to be tiled and the image to be produced. The information is:
- The raster bounds: x, y, width and height.
- The pixel density: how many world bounds units (in meters) a pixel covers vertically and horizontally.
- The number of blocks in the raster and the number of pixels in a line and in a column of a block.
- The ordering of the pixels in the lines and columns of a block.
- The size that the tiles of the destination images must adopt.
- The size of the destination image.
Since:

JViews 7.5

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_TILE_SIZE` The default size to give to the tiles of the image to load
`static int`	`NO_PIXEL` Indicates that there are no pixels in the raster for `computePixelIndex` methods.

Constructor Summary

Constructors
Constructor and Description
`IlvRasterProperties(IlvAdjustableDelegateColorModel colorModel)` Constructor initializing the size of the tile to the default value ( `DEFAULT_TILE_SIZE`).
`IlvRasterProperties(IlvInputStream stream)` Reads the `rasterinfo` from the specified input stream.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`computePixelIndex(IlvCoordinate c)` Computes the pixel value for the specified Raster coordinate.
`int`	`computePixelIndex(int srcCol, int srcLin)` Computes the index of the pixel in the original raster, its column and line coordinates.
`String`	`getBaseName()` Retrieves the path to the data source.
`int`	`getBitPixelValue()` Indicates the number of bits needed to code a pixel value in the original file.
`IlvAdjustableDelegateColorModel`	`getColorModel()` Retrieves the color model to use to produce the image.
`int`	`getColumnBlockCount()` The horizontal number of blocks in the original file.
`int`	`getColumnOrder()` The order of the blocks of pixels in the original file. 0 means from left to right, 1 means from right to left.
`int`	`getColumnPixelCount()` The number of pixels in a scan line of a block in the original file.
`double`	`getHeight()` Returns the projected vertical size of the original raster.
`double`	`getHorizontalPixelDensity()` Gets the horizontal distance (along a line of latitude) covered by a pixel.
`double`	`getInterpolatedIntPixel(IlvCoordinate c, IlvRasterMappedBuffer buff)` Interpolates inter pixel data instead of returning the exact pixel value.
`int`	`getLineBlockCount()` Gets the vertical number of blocks of pixels in the original data file.
`int`	`getLinePixelCount()` Gets the number of pixels in a scan line of a block in the original file.
`String`	`getName()` Retrieves the name of the file corresponding to the base name path.
`int`	`getNumColumns()` Returns the total number of columns in the original raster.
`int`	`getNumLines()` Returns the total number of lines in the original raster.
`int`	`getPixelBitCount()` Indicates the number of bits needed to code a pixel count in the original file.
`int`	`getPixelOrder()` The coding of the pixel index in the original file.
`int`	`getRowOrder()` The vertical order of the blocks of pixels in the original file. 0 means bottom to top, 1 means top to bottom.
`int`	`getTileHeight()` Indicates the size in pixels to adopt for the tiles used to represent the image.
`int`	`getTileWidth()` Indicates the size in pixels to adopt for the tiles used to represent the image.
`int`	`getTransparentColorIndex()` Returns the index of the color that must be used to represent a transparent color.
`int`	`getUnitFactor()` Retrieves the factor multiplying all the distance values passed to the reader.
`double`	`getVerticalPixelDensity()` Indicates the vertical distance (along a line of longitude) covered by a pixel.
`double`	`getWidth()` Returns the projected horizontal size of the original raster.
`double`	`getX()` Returns the projected horizontal coordinate of the top left corner of the original raster.
`double`	`getY()` Returns the projected vertical coordinate of the top left corner of the original raster.
`void`	`setBaseName(String baseName)` Sets the name of the path to the source of the data.
`void`	`setBitPixelValue(int b)` Sets the number of bits used to code a pixel value in the original data file.
`void`	`setBounds(IlvRect bounds)` Utility method to set the bounds of the image (x,y,width and height).
`void`	`setColorModel(IlvAdjustableDelegateColorModel colorModel)` Sets the color model to use to produce the images.
`void`	`setColumnBlockCount(int count)` Sets the horizontal number of blocks of pixels in the original data file.
`void`	`setColumnOrder(int order)` Sets if the blocks of pixels are ordered from left to right (0) or in the opposite direction (1).
`void`	`setColumnPixelCount(int count)` Sets the number of pixels in a scan line of a block of pixels in the original data file.
`void`	`setHeight(double height)` Sets the projected vertical size of the original raster.
`void`	`setHorizontalPixelDensity(double factor)` Returns the horizontal distance (along a line of latitude) covered by a pixel.
`void`	`setLineBlockCount(int count)` Sets the vertical number of blocks of pixels in the original data file.
`void`	`setLinePixelCount(int count)` Sets the number of scan lines in a block of pixels in the original data file.
`void`	`setPixelBitCount(int count)` Sets the number of bits needed to code a pixel count.
`void`	`setPixelOrder(int order)` Sets the coding of the pixel indexes.
`void`	`setRowOrder(int order)` Sets if the blocks of pixel are ordered from top to bottom (1) or in the opposite direction (0).
`void`	`setTileHeight(int tileHeight)` Sets the size in pixels to adopt for the tiles used to represent the image.
`void`	`setTileWidth(int tileWidth)` Sets the size in pixels to adopt for the tiles used to represent the image.
`void`	`setTransparentColorIndex(int index)` Sets the index of the color that must be used to represent a transparent color.
`void`	`setUnitFactor(int factor)` Set the unit of measure factor.
`void`	`setVerticalPixelDensity(double factor)` Indicates the vertical distance (along a line of longitude) covered by a pixel.
`void`	`setWidth(double width)` Sets the projected horizontal size of the original raster.
`void`	`setX(double x)` Sets the projected horizontal coordinate of the top left corner of the original raster.
`void`	`setY(double y)` Sets the projected vertical coordinate of the top left corner of the original raster.
`void`	`write(IlvOutputStream stream)` Writes the attributes of a persistent object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NO_PIXEL
```
public static final int NO_PIXEL
```
    Indicates that there are no pixels in the raster for computePixelIndex methods.
    
    See Also:
    
    computePixelIndex(IlvCoordinate), Constant Field Values
  - DEFAULT_TILE_SIZE
```
public static final int DEFAULT_TILE_SIZE
```
    The default size to give to the tiles of the image to load
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IlvRasterProperties
```
public IlvRasterProperties(IlvAdjustableDelegateColorModel colorModel)
```
    Constructor initializing the size of the tile to the default value ( DEFAULT_TILE_SIZE).
    
    Parameters:
    
    colorModel - Color model to use.
  - IlvRasterProperties
```
public IlvRasterProperties(IlvInputStream stream)
                    throws IlvReadFileException
```
    Reads the rasterinfo from the specified input stream.
    
    Parameters:
    
    stream - The input stream.
    
    Throws:
    
    IlvReadFileException - if an error occurs while reading the data.
- Method Detail
  - getInterpolatedIntPixel
```
public double getInterpolatedIntPixel(IlvCoordinate c,
                                      IlvRasterMappedBuffer buff)
```
    Interpolates inter pixel data instead of returning the exact pixel value.
    
    Parameters:
    
    c - Coordinate in the raster system ([x,x+width][y,y+height]).
    
    buff - Buffer containing pixel values.
    
    Returns:
    
    The 2D interpolated value.
  - getBaseName
```
public String getBaseName()
```
    Retrieves the path to the data source.
    
    Returns:
    
    A valid file path.
  - getBitPixelValue
```
public int getBitPixelValue()
```
    Indicates the number of bits needed to code a pixel value in the original file.
    
    Returns:
    
    The number of bits.
  - getColorModel
```
public IlvAdjustableDelegateColorModel getColorModel()
```
    Retrieves the color model to use to produce the image. The color model is used by the raster tile loader to produce the images. The nature of the color model greatly depends on the type of data stored in the IlvRasterMappedBuffer.
    
    Returns:
    
    The color model to use to produce tile images.
    
    See Also:
    
    IlvRasterMappedBuffer.getRasterDataType()
  - getColumnBlockCount
```
public int getColumnBlockCount()
```
    The horizontal number of blocks in the original file.
    
    Returns:
    
    The horizontal number of blocks.
  - getColumnOrder
```
public int getColumnOrder()
```
    The order of the blocks of pixels in the original file. 0 means from left to right, 1 means from right to left.
    
    Returns:
    
    The horizontal order of the blocks. The default value is 0.
  - getColumnPixelCount
```
public int getColumnPixelCount()
```
    The number of pixels in a scan line of a block in the original file.
    
    Returns:
    
    The number of pixels in a line of a block.
  - getHeight
```
public double getHeight()
```
    Returns the projected vertical size of the original raster.
    
    Returns:
    
    The height of the original raster.
  - getHorizontalPixelDensity
```
public double getHorizontalPixelDensity()
```
    Gets the horizontal distance (along a line of latitude) covered by a pixel. It is used with the unit factor to compute the area covered by the raster from its projected size.
    
    Returns:
    
    A factor indicating the geographical coverage of a pixel on a line of latitude.
  - getLineBlockCount
```
public int getLineBlockCount()
```
    Gets the vertical number of blocks of pixels in the original data file.
    
    Returns:
    
    The vertical number of blocks.
  - getLinePixelCount
```
public int getLinePixelCount()
```
    Gets the number of pixels in a scan line of a block in the original file.
    
    Returns:
    
    The number of pixels in a scan line.
  - getName
```
public String getName()
```
    Retrieves the name of the file corresponding to the base name path.
    
    Returns:
    
    The name of the file.
  - getNumColumns
```
public int getNumColumns()
```
    Returns the total number of columns in the original raster.
    
    Returns:
    
    Total number of columns.
  - getNumLines
```
public int getNumLines()
```
    Returns the total number of lines in the original raster.
    
    Returns:
    
    Total number of lines.
  - getPixelBitCount
```
public int getPixelBitCount()
```
    Indicates the number of bits needed to code a pixel count in the original file.
    
    Returns:
    
    The number of bits.
  - getPixelOrder
```
public int getPixelOrder()
```
    The coding of the pixel index in the original file.
    
    Returns:
    
    The coding of pixel index. Valid values are from 0 to 5 (included). Default value is 0.
  - getRowOrder
```
public int getRowOrder()
```
    The vertical order of the blocks of pixels in the original file. 0 means bottom to top, 1 means top to bottom.
    
    Returns:
    
    The vertical order of the blocks. The default value is 1.
  - getTileHeight
```
public int getTileHeight()
```
    Indicates the size in pixels to adopt for the tiles used to represent the image.
    
    Returns:
    
    A height in pixels for the tiles of the image.
  - getTileWidth
```
public int getTileWidth()
```
    Indicates the size in pixels to adopt for the tiles used to represent the image.
    
    Returns:
    
    A width in pixels for the tiles of the image.
  - getTransparentColorIndex
```
public int getTransparentColorIndex()
```
    Returns the index of the color that must be used to represent a transparent color.
    
    Returns:
    
    The transparent color index.
  - getUnitFactor
```
public int getUnitFactor()
```
    Retrieves the factor multiplying all the distance values passed to the reader.
    
    Returns:
    
    The unit multiplication factor. The default value is 1, indicating meters.
  - getVerticalPixelDensity
```
public double getVerticalPixelDensity()
```
    Indicates the vertical distance (along a line of longitude) covered by a pixel. It is used with the unit factor to compute the area covered by the raster from its projected size.
    
    Returns:
    
    A factor indicating the geographical coverage of a pixel on a line of longitude.
    
    See Also:
    
    getUnitFactor()
  - getWidth
```
public double getWidth()
```
    Returns the projected horizontal size of the original raster.
    
    Returns:
    
    The width of the original raster.
  - getX
```
public double getX()
```
    Returns the projected horizontal coordinate of the top left corner of the original raster.
    
    Returns:
    
    The original projected horizontal coordinate.
  - getY
```
public double getY()
```
    Returns the projected vertical coordinate of the top left corner of the original raster.
    
    Returns:
    
    The original projected vertical coordinate.
  - setBaseName
```
public void setBaseName(String baseName)
```
    Sets the name of the path to the source of the data.
    
    Parameters:
    
    baseName - A valid file path.
  - setBitPixelValue
```
public void setBitPixelValue(int b)
```
    Sets the number of bits used to code a pixel value in the original data file.
    
    Parameters:
    
    b - The number of bits to code a value.
  - setColorModel
```
public void setColorModel(IlvAdjustableDelegateColorModel colorModel)
```
    Sets the color model to use to produce the images. The color model is used by the raster tile loader to produce the images. The nature of the color model greatly depends on the type of data stored in the IlvRasterMappedBuffer.
    
    Parameters:
    
    colorModel - The color model to use to produce tile images.
    
    See Also:
    
    IlvRasterMappedBuffer.getRasterDataType()
  - setColumnBlockCount
```
public void setColumnBlockCount(int count)
```
    Sets the horizontal number of blocks of pixels in the original data file.
    
    Parameters:
    
    count - The horizontal number of blocks.
  - setColumnOrder
```
public void setColumnOrder(int order)
```
    Sets if the blocks of pixels are ordered from left to right (0) or in the opposite direction (1).
    
    Parameters:
    
    order - The order of the columns of the tile. Valid values are 0 and 1.
  - setColumnPixelCount
```
public void setColumnPixelCount(int count)
```
    Sets the number of pixels in a scan line of a block of pixels in the original data file.
    
    Parameters:
    
    count - The number of pixels in a line of a block.
  - setHeight
```
public void setHeight(double height)
```
    Sets the projected vertical size of the original raster.
    
    Parameters:
    
    height - The height of the original raster.
  - setHorizontalPixelDensity
```
public void setHorizontalPixelDensity(double factor)
```
    Returns the horizontal distance (along a line of latitude) covered by a pixel. It is used with the unit factor to compute the area covered by the raster from the its projected size.
    
    Parameters:
    
    factor - a factor indicating the geographical coverage of a pixel on a line of latitude.
  - setLineBlockCount
```
public void setLineBlockCount(int count)
```
    Sets the vertical number of blocks of pixels in the original data file.
    
    Parameters:
    
    count - The vertical number of blocks.
  - setLinePixelCount
```
public void setLinePixelCount(int count)
```
    Sets the number of scan lines in a block of pixels in the original data file.
    
    Parameters:
    
    count - The number of scan lines in a block.
  - setPixelBitCount
```
public void setPixelBitCount(int count)
```
    Sets the number of bits needed to code a pixel count.
    
    Parameters:
    
    count - A number of bits.
  - setPixelOrder
```
public void setPixelOrder(int order)
```
    Sets the coding of the pixel indexes. Valid values are from 0 to 5, il designates the index of the pixel in the row, ic the index of the pixel in the column, the (band) indicates the index of the band and the ibl the index of the block.
    - pixel order 0, ic il (band) ibl, columns in row in band in block.
    - pixel order 1, il ic (band) ibl
    - pixel order 2, ic il ibl (band)
    - pixel order 3, il ic ibl (band)
    - pixel order 4, ic (band) il ibl
    - pixel order 5, il (band) ic ibl
    Parameters:
    
    order - The rule to compute a pixel index in a tile.
  - setRowOrder
```
public void setRowOrder(int order)
```
    Sets if the blocks of pixel are ordered from top to bottom (1) or in the opposite direction (0).
    
    Parameters:
    
    order - The order of the rows in the tile. Valid values are 0 or 1.
  - setTileWidth
```
public void setTileWidth(int tileWidth)
```
    Sets the size in pixels to adopt for the tiles used to represent the image.
    
    Parameters:
    
    tileWidth - Width in pixels for the tiles of the image.
  - setTileHeight
```
public void setTileHeight(int tileHeight)
```
    Sets the size in pixels to adopt for the tiles used to represent the image.
    
    Parameters:
    
    tileHeight - Height in pixels for the tiles of the image.
  - setTransparentColorIndex
```
public void setTransparentColorIndex(int index)
```
    Sets the index of the color that must be used to represent a transparent color.
    
    Parameters:
    
    index - The transparent color index.
  - setUnitFactor
```
public void setUnitFactor(int factor)
```
    Set the unit of measure factor. All the distances provided will be multiplied by this factor. The default unit of measure is the meter. To provide kilometers values, set this factor to 1000. It is used with the density of pixel to compute the area covered by the raster from the its projected size.
    
    Parameters:
    
    factor - The factor to apply to all distances passed as parameter to the reader.
    
    See Also:
    
    getWidth(), getHorizontalPixelDensity(), getHeight(), getVerticalPixelDensity()
  - setVerticalPixelDensity
```
public void setVerticalPixelDensity(double factor)
```
    Indicates the vertical distance (along a line of longitude) covered by a pixel. It is used with the unit factor to compute the area covered by the raster from the its projected size.
    
    Parameters:
    
    factor - A factor indicating the geographical coverage of a pixel on longitudes axis.
  - setWidth
```
public void setWidth(double width)
```
    Sets the projected horizontal size of the original raster.
    
    Parameters:
    
    width - The width of the original raster.
  - setX
```
public void setX(double x)
```
    Sets the projected horizontal coordinate of the top left corner of the original raster.
    
    Parameters:
    
    x - The original projected horizontal coordinate.
  - setY
```
public void setY(double y)
```
    Sets the projected vertical coordinate of the top left corner of the original raster.
    
    Parameters:
    
    y - The original projected vertical coordinate.
  - write
```
public void write(IlvOutputStream stream)
           throws IOException
```
    Writes the attributes of a persistent object.
    
    Specified by:
    
    write in interface IlvPersistentObject
    
    Parameters:
    
    stream - the output stream
    
    Throws:
    
    IOException - thrown when an exception occurs during the write operation for this object.
    
    See Also:
    
    IlvPersistentObject.write(ilog.views.io.IlvOutputStream)
  - computePixelIndex
```
public int computePixelIndex(IlvCoordinate c)
```
    Computes the pixel value for the specified Raster coordinate.
    
    Parameters:
    
    c - Coordinate inside [x,x+width] and [y,y+height]
    
    Returns:
    
    The value of the pixel or NO_PIXEL.
  - computePixelIndex
```
public int computePixelIndex(int srcCol,
                             int srcLin)
```
    Computes the index of the pixel in the original raster, its column and line coordinates. It is computed from information about the raster on the row order, column order, the number of blocks, the number of bands in a block, the number of pixels in a band and the coding of the pixel index. All this information is contained in the IlvRasterProperties.
    
    Parameters:
    
    srcCol - The column of the pixel.
    
    srcLin - The line of the pixel.
    
    Returns:
    
    The index of the pixel in the original raster or NO_PIXEL.
    
    Since:
    
    JViews 7.5
  - setBounds
```
public void setBounds(IlvRect bounds)
```
    Utility method to set the bounds of the image (x,y,width and height).
    
    Parameters:
    
    bounds - bounds to use.

Class IlvRasterProperties

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NO_PIXEL

DEFAULT_TILE_SIZE

Constructor Detail

IlvRasterProperties

IlvRasterProperties

Method Detail

getInterpolatedIntPixel

getBaseName

getBitPixelValue

getColorModel

getColumnBlockCount

getColumnOrder

getColumnPixelCount

getHeight

getHorizontalPixelDensity

getLineBlockCount

getLinePixelCount

getName

getNumColumns

getNumLines

getPixelBitCount

getPixelOrder

getRowOrder

getTileHeight

getTileWidth

getTransparentColorIndex

getUnitFactor

getVerticalPixelDensity

getWidth

getX

getY

setBaseName

setBitPixelValue

setColorModel

setColumnBlockCount

setColumnOrder

setColumnPixelCount

setHeight

setHorizontalPixelDensity

setLineBlockCount

setLinePixelCount

setPixelBitCount

setPixelOrder

setRowOrder

setTileWidth

setTileHeight

setTransparentColorIndex

setUnitFactor

setVerticalPixelDensity

setWidth

setX

setY

write

computePixelIndex

computePixelIndex

setBounds