com.esri.arcgis.datasourcesraster
Class RasterColormap

java.lang.Object
  extended by com.esri.arcgis.datasourcesraster.RasterColormap
All Implemented Interfaces:
IRasterColormap2, IRasterColormap, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class RasterColormap
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterColormap, IRasterColormap2

A container for a colormap used to display a raster band.

Remarks

RasterColormap object defines the relationship of the pixels in the raster band and the color indices to be used in the display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
RasterColormap()
          Constructs a RasterColormap using ArcGIS Engine.
RasterColormap(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterColormap theRasterColormap = (RasterColormap) obj;
 
Method Summary
 int bin(double pixval)
          Translates pixel values into integers to index them into the colormap.
 boolean equals(Object o)
          Compare this object with another
 IBinFunction getBinFunction()
          The Bin function that maps pixel value into colormap index.
 Object getBlueValues()
          Array of blue ratios as doubles between 0.0 and 1.0.
static String getClsid()
          getClsid.
 Object getColors()
          Array of colors as OLE_COLORs.
 Object getGreenValues()
          Array of green ratios as doubles between 0.0 and 1.0.
 Object getRedValues()
          Array of red ratios as doubles between 0.0 and 1.0.
 Object getRemappedBlueValues()
          The remapped Blue color component values using LUT from index to value (OBJECTID, VALUE).
 Object getRemappedColors()
          The remapped colors using LUT from index to value (OBJECTID, VALUE).
 Object getRemappedGreenValues()
          The remapped Green color component values using LUT from index to value (OBJECTID, VALUE).
 Object getRemappedRedValues()
          The remapped Red color component values using LUT from index to value (OBJECTID, VALUE).
 int hashCode()
          the hashcode for this object
 void setBlueValues(Object val)
          Array of blue ratios as doubles between 0.0 and 1.0.
 void setColors(Object val)
          Array of colors as OLE_COLORs.
 void setGreenValues(Object val)
          Array of green ratios as doubles between 0.0 and 1.0.
 void setLUT(ITable rhs1)
          The lookup table (OBJECTID, VALUE) for remaping from index to pixel value.
 void setRedValues(Object val)
          Array of red ratios as doubles between 0.0 and 1.0.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

RasterColormap

public RasterColormap()
               throws IOException,
                      UnknownHostException
Constructs a RasterColormap using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

RasterColormap

public RasterColormap(Object obj)
               throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterColormap theRasterColormap = (RasterColormap) obj;

Construct a RasterColormap using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RasterColormap.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getRedValues

public Object getRedValues()
                    throws IOException,
                           AutomationException
Array of red ratios as doubles between 0.0 and 1.0.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getRedValues in interface IRasterColormap
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRedValues

public void setRedValues(Object val)
                  throws IOException,
                         AutomationException
Array of red ratios as doubles between 0.0 and 1.0.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setRedValues in interface IRasterColormap
Parameters:
val - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGreenValues

public Object getGreenValues()
                      throws IOException,
                             AutomationException
Array of green ratios as doubles between 0.0 and 1.0.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getGreenValues in interface IRasterColormap
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGreenValues

public void setGreenValues(Object val)
                    throws IOException,
                           AutomationException
Array of green ratios as doubles between 0.0 and 1.0.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setGreenValues in interface IRasterColormap
Parameters:
val - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBlueValues

public Object getBlueValues()
                     throws IOException,
                            AutomationException
Array of blue ratios as doubles between 0.0 and 1.0.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBlueValues in interface IRasterColormap
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBlueValues

public void setBlueValues(Object val)
                   throws IOException,
                          AutomationException
Array of blue ratios as doubles between 0.0 and 1.0.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBlueValues in interface IRasterColormap
Parameters:
val - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColors

public Object getColors()
                 throws IOException,
                        AutomationException
Array of colors as OLE_COLORs.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getColors in interface IRasterColormap
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setColors

public void setColors(Object val)
               throws IOException,
                      AutomationException
Array of colors as OLE_COLORs.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setColors in interface IRasterColormap
Parameters:
val - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

bin

public int bin(double pixval)
        throws IOException,
               AutomationException
Translates pixel values into integers to index them into the colormap.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
bin in interface IRasterColormap
Parameters:
pixval - The pixval (in)
Returns:
The bin
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLUT

public void setLUT(ITable rhs1)
            throws IOException,
                   AutomationException
The lookup table (OBJECTID, VALUE) for remaping from index to pixel value.

Description

Set the lookup table to map index to raster pixel value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setLUT in interface IRasterColormap2
Parameters:
rhs1 - A reference to a com.esri.arcgis.geodatabase.ITable (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRemappedColors

public Object getRemappedColors()
                         throws IOException,
                                AutomationException
The remapped colors using LUT from index to value (OBJECTID, VALUE).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getRemappedColors in interface IRasterColormap2
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRemappedRedValues

public Object getRemappedRedValues()
                            throws IOException,
                                   AutomationException
The remapped Red color component values using LUT from index to value (OBJECTID, VALUE).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getRemappedRedValues in interface IRasterColormap2
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRemappedGreenValues

public Object getRemappedGreenValues()
                              throws IOException,
                                     AutomationException
The remapped Green color component values using LUT from index to value (OBJECTID, VALUE).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getRemappedGreenValues in interface IRasterColormap2
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRemappedBlueValues

public Object getRemappedBlueValues()
                             throws IOException,
                                    AutomationException
The remapped Blue color component values using LUT from index to value (OBJECTID, VALUE).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getRemappedBlueValues in interface IRasterColormap2
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBinFunction

public IBinFunction getBinFunction()
                            throws IOException,
                                   AutomationException
The Bin function that maps pixel value into colormap index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getBinFunction in interface IRasterColormap2
Returns:
A reference to a com.esri.arcgis.datasourcesraster.IBinFunction
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.