com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class AddColormap

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.AddColormap

All Implemented Interfaces:

GPTool

public class AddColormap
extends AbstractGPTool

Adds a color map to a raster dataset if it does not already exist or replaces a color map with the one specified. The Add Colormap tool is contained in the Data Management Tools tool box.

Usage tips:

• The color map applied to the input raster dataset can originate from a raster dataset that already has a color map, a .CLR file, or an .ACT file.
• This tool will not work when the color map is internally stored in the attribute table of an IMG or TIFF dataset. If the attribute table contains the fields "Red", "Green", and "Blue", that means this tool cannot be used.
• The input raster dataset must be a single band raster dataset with integer values. Color maps can only be created for single-band raster datasets with a pixel depth of 16-bit unsigned or fewer. Certain formats cannot have a color map associated with them; please consult the section.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

AddColormap()
Creates the Add Colormap tool with defaults.

AddColormap(Object inRaster)
Creates the Add Colormap tool with the required parameters.

Method Summary

Object	getInputCLRFile() Returns the Input .clr or .act File parameter of this tool .
Object	getInRaster() Returns the Input Raster parameter of this tool .
Object	getInTemplateRaster() Returns the Input Template Raster parameter of this tool .
Object	getOutRaster() Returns the Output Raster parameter of this tool (Read only).
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setInputCLRFile(Object inputCLRFile) Sets the Input .clr or .act File parameter of this tool .
void	setInRaster(Object inRaster) Sets the Input Raster parameter of this tool .
void	setInTemplateRaster(Object inTemplateRaster) Sets the Input Template Raster parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AddColormap

public AddColormap()

Creates the Add Colormap tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

AddColormap

public AddColormap(Object inRaster)

Creates the Add Colormap tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

inRaster - the input raster dataset to which you want to add a color map.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input Raster parameter of this tool . This parameter is the input raster dataset to which you want to add a color map. This is a required parameter.

Returns:

the Input Raster

setInRaster

public void setInRaster(Object inRaster)

Sets the Input Raster parameter of this tool . This parameter is the input raster dataset to which you want to add a color map. This is a required parameter.

Parameters:

inRaster - the input raster dataset to which you want to add a color map.

getInTemplateRaster

public Object getInTemplateRaster()

Returns the Input Template Raster parameter of this tool . This parameter is the raster dataset with a color map, that will be applied to the input raster dataset. If this is entered the in_template_raster cannot be specified. This is an optional parameter.

Returns:

the Input Template Raster

setInTemplateRaster

public void setInTemplateRaster(Object inTemplateRaster)

Sets the Input Template Raster parameter of this tool . This parameter is the raster dataset with a color map, that will be applied to the input raster dataset. If this is entered the in_template_raster cannot be specified. This is an optional parameter.

Parameters:

inTemplateRaster - the raster dataset with a color map, that will be applied to the input raster dataset. If this is entered the in_template_raster cannot be specified.

getInputCLRFile

public Object getInputCLRFile()

Returns the Input .clr or .act File parameter of this tool . This parameter is the .clr or .act file, which will be used as the template color map for the input raster dataset. If this is entered the input_CLR_file cannot be specified. This is an optional parameter.

Returns:

the Input .clr or .act File

setInputCLRFile

public void setInputCLRFile(Object inputCLRFile)

Sets the Input .clr or .act File parameter of this tool . This parameter is the .clr or .act file, which will be used as the template color map for the input raster dataset. If this is entered the input_CLR_file cannot be specified. This is an optional parameter.

Parameters:

inputCLRFile - the .clr or .act file, which will be used as the template color map for the input raster dataset. If this is entered the input_CLR_file cannot be specified.

getOutRaster

public Object getOutRaster()

Returns the Output Raster parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Raster

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias