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

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

All Implemented Interfaces:

GPTool

public class Reclassify
extends AbstractGPTool

Reclassifies (or changes) the values in a raster. The Reclassify tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• The input raster must have valid statistics. If the statistics do not exist, they can be created using the tool in the Data Management Tools toolbox.
• If using the tool dialog box, the remap table can be stored for future use with the Save button. Use the Load button to open the remap tables you created previously with the Save button.
• It is recommended to only load tables previously saved by the Reclassify tool. The table format is specific and must contain the fields FROM, TO, OUT, and MAPPING.
• By default, the input raster will be classified into nine classes for the reclassification table.
• If the input raster is a layer, the old values of the reclassification will be obtained from the renderer. If the renderer is stretched, the reclassification will default to 255 classes.
• Once the remap table of the reclassification has been modified, the values will not be updated if a new input raster is selected. If the reclassification is not suitable for the new raster, a default reclassification can be reinitialized by:
• This tool has a precision control that manages how decimal places are treated.
• When using the Reclassify tool as part of a model:

Field Summary

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

vals

Constructor Summary

Reclassify()
Creates the Reclassify tool with defaults.

Reclassify(Object inRaster, Object reclassField, Object remap, Object outRaster)
Creates the Reclassify tool with the required parameters.

Method Summary

Object	getInRaster() Returns the Input raster parameter of this tool .
String	getMissingValues() Returns the Change missing values to NoData parameter of this tool .
Object	getOutRaster() Returns the Output raster parameter of this tool .
Object	getReclassField() Returns the Reclass field parameter of this tool .
Object	getRemap() Returns the Reclassification 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	setMissingValues(String missingValues) Sets the Change missing values to NoData parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output raster parameter of this tool .
void	setReclassField(Object reclassField) Sets the Reclass field parameter of this tool .
void	setRemap(Object remap) Sets the Reclassification 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

Reclassify

public Reclassify()

Creates the Reclassify tool with defaults.

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

Reclassify

public Reclassify(Object inRaster,
                  Object reclassField,
                  Object remap,
                  Object outRaster)

Creates the Reclassify 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 to be reclassified.

reclassField - field denoting the values that will be reclassified.

remap - a remap list that defines how the values will be reclassified. the remap list is composed of three components: From, To, and New values. Each row in the remap list is separated by a semicolon, and the three components are separated by spaces. For example: "0 5 1;5.01 7.5 2;7.5 10 3"

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 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 the input raster to be reclassified. This is a required parameter.

Parameters:

inRaster - the input raster to be reclassified.

getReclassField

public Object getReclassField()

Returns the Reclass field parameter of this tool . This parameter is field denoting the values that will be reclassified. This is a required parameter.

Returns:

the Reclass field

setReclassField

public void setReclassField(Object reclassField)

Sets the Reclass field parameter of this tool . This parameter is field denoting the values that will be reclassified. This is a required parameter.

Parameters:

reclassField - field denoting the values that will be reclassified.

getRemap

public Object getRemap()

Returns the Reclassification parameter of this tool . This parameter is a remap list that defines how the values will be reclassified. the remap list is composed of three components: From, To, and New values. Each row in the remap list is separated by a semicolon, and the three components are separated by spaces. For example: "0 5 1;5.01 7.5 2;7.5 10 3" This is a required parameter.

Returns:

the Reclassification

setRemap

public void setRemap(Object remap)

Sets the Reclassification parameter of this tool . This parameter is a remap list that defines how the values will be reclassified. the remap list is composed of three components: From, To, and New values. Each row in the remap list is separated by a semicolon, and the three components are separated by spaces. For example: "0 5 1;5.01 7.5 2;7.5 10 3" This is a required parameter.

Parameters:

remap - a remap list that defines how the values will be reclassified. the remap list is composed of three components: From, To, and New values. Each row in the remap list is separated by a semicolon, and the three components are separated by spaces. For example: "0 5 1;5.01 7.5 2;7.5 10 3"

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.

getMissingValues

public String getMissingValues()

Returns the Change missing values to NoData parameter of this tool . This parameter is 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 denotes whether missing values in the reclass table retain their value or get mapped to NoData. This is an optional parameter.

Parameters:

missingValues - 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