com.esri.arcgis.geoprocessing.tools.spatialanalysttools
Class ReclassByTable

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.spatialanalysttools.ReclassByTable

All Implemented Interfaces:

GPTool

public class ReclassByTable
extends AbstractGPTool

Reclassifies or changes the values of the input cells of a raster using a remap table. The Reclass by Table tool is contained in the Spatial Analyst Tools tool box.

Software restrictions: none

Usage tips:

• The input raster must have valid statistics. If the statistics do not exist, they can be created in two ways. The first is to right-click the raster in ArcCatalog and click Calculate Statistics. The other is to open the Data Management Tools toolbox, Raster toolset, Calculate Statistics tool in ArcToolbox.
• The 'from value field', 'to value field', and 'output value field' are the field names in the table that define the remapping.
• To reclassify individual values, use a simple remap table of two items. The first item identifies the value to reclassify, and the other item identifies the value to assign to it. Set the 'to value field' the same as the 'from value field'. The value to assign to the output is 'output value field'.
• To reclassify ranges of values, the remap table must have items defining the start and end of each range, along with the value to assign the range. The item defining the start of the range is the 'from value field', and the value defining the end of the range is the 'to value field'. The value to assign to the output is 'output value field'.
• The remap table can be an INFO table, a .dbf file, an Access table, or a text file.
• The values in the from and to fields can be any numerical item. The assignment values in the output field must be integers.
• Values in the from field for .dbf, INFO and Geodatabase tables do not need to be sorted. For text-file based tables, they must be sorted in ascending order. The values should not overlap in either case.
• The output raster will always be of integer type.
• The following environment settings affect this tool:

Field Summary

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

vals

Constructor Summary

ReclassByTable()
Creates the Reclass by Table tool with defaults.

ReclassByTable(Object inRaster, Object inRemapTable, Object fromValueField, Object toValueField, Object outputValueField, Object outRaster)
Creates the Reclass by Table tool with the required parameters.

Method Summary

Object	getFromValueField() Returns the From value field parameter of this tool .
Object	getInRaster() Returns the Input raster parameter of this tool .
Object	getInRemapTable() Returns the Input remap table parameter of this tool .
String	getMissingValues() Returns the Change missing values to NoData parameter of this tool .
Object	getOutputValueField() Returns the Output value 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.
Object	getToValueField() Returns the To value field parameter of this tool .
void	setFromValueField(Object fromValueField) Sets the From value field parameter of this tool .
void	setInRaster(Object inRaster) Sets the Input raster parameter of this tool .
void	setInRemapTable(Object inRemapTable) Sets the Input remap table parameter of this tool .
void	setMissingValues(String missingValues) Sets the Change missing values to NoData parameter of this tool .
void	setOutputValueField(Object outputValueField) Sets the Output value field parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output raster parameter of this tool .
void	setToValueField(Object toValueField) Sets the To value field 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

ReclassByTable

public ReclassByTable()

Creates the Reclass by Table tool with defaults.

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

ReclassByTable

public ReclassByTable(Object inRaster,
                      Object inRemapTable,
                      Object fromValueField,
                      Object toValueField,
                      Object outputValueField,
                      Object outRaster)

Creates the Reclass by Table 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 - Composite Geodataset, the values contained in this raster will be the values to be reclassified.

inRemapTable - Table View, table holding fields defining value ranges to be reclassified and the values they will become.

fromValueField - Field, this is a numeric field of in_remap_table.

toValueField - Field, this is a numeric field of in_remap_table.

outputValueField - Field, this is an integer field of in_remap_table.

outRaster - Raster Dataset, the raster to be created.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input raster parameter of this tool . This parameter is Composite Geodataset, the values contained in this raster will be the values to be reclassified. 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 Composite Geodataset, the values contained in this raster will be the values to be reclassified. This is a required parameter.

Parameters:

inRaster - Composite Geodataset, the values contained in this raster will be the values to be reclassified.

getInRemapTable

public Object getInRemapTable()

Returns the Input remap table parameter of this tool . This parameter is Table View, table holding fields defining value ranges to be reclassified and the values they will become. This is a required parameter.

Returns:

the Input remap table

setInRemapTable

public void setInRemapTable(Object inRemapTable)

Sets the Input remap table parameter of this tool . This parameter is Table View, table holding fields defining value ranges to be reclassified and the values they will become. This is a required parameter.

Parameters:

inRemapTable - Table View, table holding fields defining value ranges to be reclassified and the values they will become.

getFromValueField

public Object getFromValueField()

Returns the From value field parameter of this tool . This parameter is Field, this is a numeric field of in_remap_table. This is a required parameter.

Returns:

the From value field

setFromValueField

public void setFromValueField(Object fromValueField)

Sets the From value field parameter of this tool . This parameter is Field, this is a numeric field of in_remap_table. This is a required parameter.

Parameters:

fromValueField - Field, this is a numeric field of in_remap_table.

getToValueField

public Object getToValueField()

Returns the To value field parameter of this tool . This parameter is Field, this is a numeric field of in_remap_table. This is a required parameter.

Returns:

the To value field

setToValueField

public void setToValueField(Object toValueField)

Sets the To value field parameter of this tool . This parameter is Field, this is a numeric field of in_remap_table. This is a required parameter.

Parameters:

toValueField - Field, this is a numeric field of in_remap_table.

getOutputValueField

public Object getOutputValueField()

Returns the Output value field parameter of this tool . This parameter is Field, this is an integer field of in_remap_table. This is a required parameter.

Returns:

the Output value field

setOutputValueField

public void setOutputValueField(Object outputValueField)

Sets the Output value field parameter of this tool . This parameter is Field, this is an integer field of in_remap_table. This is a required parameter.

Parameters:

outputValueField - Field, this is an integer field of in_remap_table.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is Raster Dataset, the raster to be created. 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 Raster Dataset, the raster to be created. This is a required parameter.

Parameters:

outRaster - Raster Dataset, the raster to be created.

getMissingValues

public String getMissingValues()

Returns the Change missing values to NoData parameter of this tool . This parameter is String, denotes whether missing values in the reclass table retain their value or get mapped to NoData. This is an optional parameter.

Returns:

the Change missing values to NoData

setMissingValues

public void setMissingValues(String missingValues)

Sets the Change missing values to NoData parameter of this tool . This parameter is String, denotes whether missing values in the reclass table retain their value or get mapped to NoData. This is an optional parameter.

Parameters:

missingValues - String, denotes whether missing values in the reclass table retain their value or get mapped to NoData.

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