com.esri.arcgis.geoprocessing.tools.analyst3dtools
Class Lookup

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.analyst3dtools.Lookup

All Implemented Interfaces:

GPTool

public class Lookup
extends AbstractGPTool

Creates a new raster by looking up values found in another field in the table of the input raster. The Lookup tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• If the lookup field is a numeric type, the values of that field will be written to the output raster attribute table as Value. Other items in the input raster attribute table will not be transferred to the output raster attribute table.For example, an attribute table of input raster with numeric field Attr1:Output attribute table from Lookup on Attr1 field:
• If the lookup field is a character type, the lookup field will appear in the output raster attribute table, and the value field will be the same as for input raster. Any other items in the input raster's attribute table will not be transferred to the output raster's attribute table.For example, an attribute table of input raster with character field Text1:Output attribute table from Lookup on Text1 field:

Field Summary

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

vals

Constructor Summary

Lookup()
Creates the Lookup tool with defaults.

Lookup(Object inRaster, Object lookupField, Object outRaster)
Creates the Lookup tool with the required parameters.

Method Summary

Object	getInRaster() Returns the Input raster parameter of this tool .
Object	getLookupField() Returns the Lookup field parameter of this tool .
Object	getOutRaster() Returns the Output raster parameter of this tool .
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	setInRaster(Object inRaster) Sets the Input raster parameter of this tool .
void	setLookupField(Object lookupField) Sets the Lookup field parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output 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

Lookup

public Lookup()

Creates the Lookup tool with defaults.

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

Lookup

public Lookup(Object inRaster,
              Object lookupField,
              Object outRaster)

Creates the Lookup 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 that contains a field from which to create a new raster.

lookupField - field containing the values for the new raster.

outRaster - the output reclassified raster. the output will always be of integer type.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input raster parameter of this tool . This parameter is the input raster that contains a field from which to create a new raster. 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 that contains a field from which to create a new raster. This is a required parameter.

Parameters:

inRaster - the input raster that contains a field from which to create a new raster.

getLookupField

public Object getLookupField()

Returns the Lookup field parameter of this tool . This parameter is field containing the values for the new raster. This is a required parameter.

Returns:

the Lookup field

setLookupField

public void setLookupField(Object lookupField)

Sets the Lookup field parameter of this tool . This parameter is field containing the values for the new raster. This is a required parameter.

Parameters:

lookupField - field containing the values for the new raster.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output reclassified raster. the output will always be of integer type. This is a required parameter.

Returns:

the Output raster

setOutRaster

public void setOutRaster(Object outRaster)

Sets the Output raster parameter of this tool . This parameter is the output reclassified raster. the output will always be of integer type. This is a required parameter.

Parameters:

outRaster - the output reclassified raster. the output will always be of integer type.

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