com.esri.arcgis.geoprocessing.tools.conversiontools
Class RasterToASCII

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.conversiontools.RasterToASCII

All Implemented Interfaces:

GPTool

public class RasterToASCII
extends AbstractGPTool

Converts a raster dataset to an ASCII text file representing raster data. The Raster to ASCII tool is contained in the Conversion Tools tool box.

Usage tips:

• The input raster dataset can be any valid raster dataset.
• The structure of the ASCII file consists of header information containing a set of keywords, followed by cell values in row-major order.The format of the file in general is:The definitions of the keywords are as follows:
• An example of an ASCII raster file is:
• The NODATA_VALUE is the value in the ASCII file that will represent cells that are NoData in the input raster. This value is normally reserved for those cells whose true value is unknown.
• The end of each row of data from the raster is terminated with a carriage return character in the file.
• Both integer and floating point rasters can be converted to an ASCII raster file.
• This tool only writes the origin as the lower left corner of the lower left cell. The ASCII to Raster tool also supports the origin as the center of the lower left cell.

Field Summary

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

vals

Constructor Summary

RasterToASCII()
Creates the Raster to ASCII tool with defaults.

RasterToASCII(Object inRaster, Object outAsciiFile)
Creates the Raster to ASCII tool with the required parameters.

Method Summary

Object	getInRaster() Returns the Input raster parameter of this tool .
Object	getOutAsciiFile() Returns the Output ASCII raster file 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	setOutAsciiFile(Object outAsciiFile) Sets the Output ASCII raster file 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

RasterToASCII

public RasterToASCII()

Creates the Raster to ASCII tool with defaults.

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

RasterToASCII

public RasterToASCII(Object inRaster,
                     Object outAsciiFile)

Creates the Raster to ASCII 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. the raster can be integer or floating-point type.

outAsciiFile - the output ASCII raster file.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input raster parameter of this tool . This parameter is the input raster dataset. the raster can be integer or floating-point type. 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. the raster can be integer or floating-point type. This is a required parameter.

Parameters:

inRaster - the input raster dataset. the raster can be integer or floating-point type.

getOutAsciiFile

public Object getOutAsciiFile()

Returns the Output ASCII raster file parameter of this tool . This parameter is the output ASCII raster file. This is a required parameter.

Returns:

the Output ASCII raster file

setOutAsciiFile

public void setOutAsciiFile(Object outAsciiFile)

Sets the Output ASCII raster file parameter of this tool . This parameter is the output ASCII raster file. This is a required parameter.

Parameters:

outAsciiFile - the output ASCII raster file.

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