All Packages  Class Hierarchy  This Package  Previous  Next  Index
  Class com.las.ogdi.OGDIRasterInfo
java.lang.Object
   |
   +----com.las.ogdi.OGDIRasterInfo
  -  public class OGDIRasterInfo
  -  extends Object
The RasterInfo class defines an object with minimum and maximum categories
 and a table of category-to-color (with labels). Applies to matrix/image only.
  -  Version:
  
-  1.1
  
-  Author:
  
-  Las Inc.
   
  -   OGDIRasterInfo(int, int, int, DirectColorModel) OGDIRasterInfo(int, int, int, DirectColorModel)
-   Creates a RasterInfo instance for Image family.
  
-   OGDIRasterInfo(int, int, OGDIIndexColorModel) OGDIRasterInfo(int, int, OGDIIndexColorModel)
-   Creates a RasterInfo instance for Matrix family.
   
  -   getCallback() getCallback()
-   Gets the current callback for the value/category transformation.
  
-   getColorModel() getColorModel()
-   Gets the table of colors (for matrix, where the index is the category).
  
-   getMaxCat() getMaxCat()
-   Gets one maximum color/category for the matrix datasource.
  
-   getMinCat() getMinCat()
-   Gets one minimum color/category for the matrix datasource.
  
-   getWidth() getWidth()
-   Gets the width of the raster (used as the type for Image where 1=RGB, etc).
  
-   setCallback(OGDIRasterCallback) setCallback(OGDIRasterCallback)
-   Sets the current callback for the value/category transformation.
  
-   toString() toString()
-   Gets the complete rasterInfo description.
   
 OGDIRasterInfo
OGDIRasterInfo
 public OGDIRasterInfo(int mincat,
                       int maxcat,
                       OGDIIndexColorModel cat)
  -  Creates a RasterInfo instance for Matrix family.
 Category 0 represents "no information" (transparent).
   
- 
    -  Parameters:
    
-  mincat - the minimum category for that matrix
    -  maxcat - the maximum category for that matrix
    -  cat - the table of colors
    
-  Returns:
    
-  no return
    
-  Throws: IllegalArgumentException
    
-  if minimum or maximum are out of range or categories are null
  
 
 OGDIRasterInfo
OGDIRasterInfo
 public OGDIRasterInfo(int mincat,
                       int maxcat,
                       int type,
                       DirectColorModel cat)
  -  Creates a RasterInfo instance for Image family.
   
- 
    -  Parameters:
    
-  mincat - the minimum pixel value for that image
    -  maxcat - the maximum pixel value for that image
    -  type - the type of image (1=RGB, 2=8 ubits, 3=16 ubits, 4=16 bits signed, 5=32 bits)
    -  cat - the table of colors
    
-  Returns:
    
-  no return
    
-  Throws: IllegalArgumentException
    
-  if minimum or maximum are out of range or colors are null
  
 
   
 getWidth
getWidth
 public int getWidth()
  -  Gets the width of the raster (used as the type for Image where 1=RGB, etc).
   
- 
    -  Parameters:
    
-  no - parameter
    
-  Returns:
    
-  the width or type of the raster
    
-  Throws: no
    
-  exception
  
 
 getMinCat
getMinCat
 public int getMinCat()
  -  Gets one minimum color/category for the matrix datasource.
   
- 
    -  Parameters:
    
-  no - parameter
    
-  Returns:
    
-  the minimum color/category in the color table
    
-  Throws: no
    
-  exception
  
 
 getMaxCat
getMaxCat
 public int getMaxCat()
  -  Gets one maximum color/category for the matrix datasource.
   
- 
    -  Parameters:
    
-  no - parameter
    
-  Returns:
    
-  the maximum color/category in the color table
    
-  Throws: no
    
-  exception
  
 
 getColorModel
getColorModel
 public ColorModel getColorModel()
  -  Gets the table of colors (for matrix, where the index is the category).
   
- 
    -  Parameters:
    
-  no - parameter
    
-  Returns:
    
-  the ColorModel reference
    
-  Throws: no
    
-  exception
  
 
 getCallback
getCallback
 public OGDIRasterCallback getCallback()
  -  Gets the current callback for the value/category transformation.
   
- 
    -  Parameters:
    
-  no - parameter
    
-  Returns:
    
-  the callback object
    
-  Throws: no
    
-  exception
  
 
 setCallback
setCallback
 public void setCallback(OGDIRasterCallback callback)
  -  Sets the current callback for the value/category transformation.
 There is a default implementation for each raster type.
   
- 
    -  Parameters:
    
-  callback - a callback processor of pixel values/categories
    
-  Returns:
    
-  no return
    
-  Throws: no
    
-  exception
  
 
 toString
toString
 public String toString()
  -  Gets the complete rasterInfo description.
   
- 
    -  Parameters:
    
-  no - parameter
    
-  Returns:
    
-  the raster info minimum, maximum and table of categories as a string
    
-  Throws: no
    
-  exception
    
-  Overrides:
    
-  toString in class Object
  
 
All Packages  Class Hierarchy  This Package  Previous  Next  Index