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

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

All Implemented Interfaces:

GPTool

public class ASCIIToRaster
extends AbstractGPTool

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

Usage tips:

• The input file is an ASCII format text file.
• The structure of the ASCII file consists of header information containing a set of keywords, followed by cell values in row-major order.There are two variations of the structure of the ASCII file. One identifies the origin by the coordinates of the lower left corner of the lower left cell, or as the center of the lower left cell.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 be assigned to NoData cells in the output raster. This value is normally reserved for those cells whose true value is unknown.
• The number of cell values contained in the file must be equal to the number of rows times the number of columns, or an error will be returned.
• The output data type can be either float or integer.

Field Summary

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

vals

Constructor Summary

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

ASCIIToRaster(java.lang.Object inAsciiFile, java.lang.Object outRaster)
Creates the ASCII to Raster tool with the required parameters.

Method Summary

java.lang.String	getDataType() Returns the Output data type parameter of this tool .
java.lang.Object	getInAsciiFile() Returns the Input ASCII raster file parameter of this tool .
java.lang.Object	getOutRaster() Returns the Output raster parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
void	setDataType(java.lang.String dataType) Sets the Output data type parameter of this tool .
void	setInAsciiFile(java.lang.Object inAsciiFile) Sets the Input ASCII raster file parameter of this tool .
void	setOutRaster(java.lang.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

ASCIIToRaster

public ASCIIToRaster()

Creates the ASCII to Raster tool with defaults.

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

ASCIIToRaster

public ASCIIToRaster(java.lang.Object inAsciiFile,
                     java.lang.Object outRaster)

Creates the ASCII to Raster 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:

inAsciiFile - the input ASCII file to be converted.

outRaster - the output raster dataset to be created. when not saving to a geodatabase, specify .tif for a TIFF file format, .img for an ERDAS IMAGINE file format, or no extension for a GRID raster format.

Method Detail

getInAsciiFile

public java.lang.Object getInAsciiFile()

Returns the Input ASCII raster file parameter of this tool . This parameter is the input ASCII file to be converted. This is a required parameter.

Returns:

the Input ASCII raster file

setInAsciiFile

public void setInAsciiFile(java.lang.Object inAsciiFile)

Sets the Input ASCII raster file parameter of this tool . This parameter is the input ASCII file to be converted. This is a required parameter.

Parameters:

inAsciiFile - the input ASCII file to be converted.

getOutRaster

public java.lang.Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output raster dataset to be created. when not saving to a geodatabase, specify .tif for a TIFF file format, .img for an ERDAS IMAGINE file format, or no extension for a GRID raster format. This is a required parameter.

Returns:

the Output raster

setOutRaster

public void setOutRaster(java.lang.Object outRaster)

Sets the Output raster parameter of this tool . This parameter is the output raster dataset to be created. when not saving to a geodatabase, specify .tif for a TIFF file format, .img for an ERDAS IMAGINE file format, or no extension for a GRID raster format. This is a required parameter.

Parameters:

outRaster - the output raster dataset to be created. when not saving to a geodatabase, specify .tif for a TIFF file format, .img for an ERDAS IMAGINE file format, or no extension for a GRID raster format.

getDataType

public java.lang.String getDataType()

Returns the Output data type parameter of this tool . This parameter is the data type of the output raster dataset. This is an optional parameter.

Returns:

the Output data type

setDataType

public void setDataType(java.lang.String dataType)

Sets the Output data type parameter of this tool . This parameter is the data type of the output raster dataset. This is an optional parameter.

Parameters:

dataType - the data type of the output raster dataset.

getToolName

public java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias