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

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

All Implemented Interfaces:

GPTool

public class ReclassByASCIIFile
extends AbstractGPTool

Reclassifies or changes the values of the input cells of a raster using an ASCII remap file. The Reclass by ASCII File tool is contained in the Spatial 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.
• The output raster will always be of integer type. If the output assignment values in the ASCII file are floating-point values, an error message will be returned and the program will halt.

Field Summary

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

vals

Constructor Summary

ReclassByASCIIFile()
Creates the Reclass by ASCII File tool with defaults.

ReclassByASCIIFile(Object inRaster, Object inRemapFile, Object outRaster)
Creates the Reclass by ASCII File tool with the required parameters.

Method Summary

Object	getInRaster() Returns the Input raster parameter of this tool .
Object	getInRemapFile() Returns the Input ASCII remap file 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 .
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	setInRemapFile(Object inRemapFile) Sets the Input ASCII remap file 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 .

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

ReclassByASCIIFile

public ReclassByASCIIFile()

Creates the Reclass by ASCII File tool with defaults.

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

ReclassByASCIIFile

public ReclassByASCIIFile(Object inRaster,
                          Object inRemapFile,
                          Object outRaster)

Creates the Reclass by ASCII File 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.

inRemapFile - aSCII remap file defining the single values or ranges to be reclassified and the values they will become. allowed extensions for the ASCII remap files are .rmp, .txt, and .asc.

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.

getInRemapFile

public Object getInRemapFile()

Returns the Input ASCII remap file parameter of this tool . This parameter is aSCII remap file defining the single values or ranges to be reclassified and the values they will become. allowed extensions for the ASCII remap files are .rmp, .txt, and .asc. This is a required parameter.

Returns:

the Input ASCII remap file

setInRemapFile

public void setInRemapFile(Object inRemapFile)

Sets the Input ASCII remap file parameter of this tool . This parameter is aSCII remap file defining the single values or ranges to be reclassified and the values they will become. allowed extensions for the ASCII remap files are .rmp, .txt, and .asc. This is a required parameter.

Parameters:

inRemapFile - aSCII remap file defining the single values or ranges to be reclassified and the values they will become. allowed extensions for the ASCII remap files are .rmp, .txt, and .asc.

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 file 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 file retain their value or get mapped to NoData. This is an optional parameter.

Parameters:

missingValues - denotes whether missing values in the reclass file 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