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

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

All Implemented Interfaces:

GPTool

public class RasterToFloat
extends AbstractGPTool

Converts a raster dataset to a file of binary floating-point values representing raster data. The Raster to Float tool is contained in the Conversion Tools tool box.

Usage tips:

• The input can be any valid raster dataset.
• Two outputs are created: an IEEE floating-point format 32-bit signed binary file with a .flt extension and an ASCII header file with a .hdr extension. Both will use the same output floating-point raster file name.
• The ASCII file consists of header information containing a set of keywords.The format of the file in general is:The definitions of the keywords are as follows:
• The NODATA_VALUE is the value in the output file assigned to those cells in the input raster that contain NoData. This value is normally reserved for those cells whose true value is unknown.
• By default, NoData values on the input raster will have a value of -9999 in the output float file. If you want to use another value to represent NoData, a procedure similar to the following can be applied:
• This tool only writes the origin as the lower left corner of the lower left cell. The Float 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

RasterToFloat()
Creates the Raster to Float tool with defaults.

RasterToFloat(Object inRaster, Object outFloatFile)
Creates the Raster to Float tool with the required parameters.

Method Summary

Object	getInRaster() Returns the Input raster parameter of this tool .
Object	getOutFloatFile() Returns the Output floating point 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	setOutFloatFile(Object outFloatFile) Sets the Output floating point 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

RasterToFloat

public RasterToFloat()

Creates the Raster to Float tool with defaults.

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

RasterToFloat

public RasterToFloat(Object inRaster,
                     Object outFloatFile)

Creates the Raster to Float 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.

outFloatFile - the output floating-point raster file. the file name must have a .flt extension.

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.

getOutFloatFile

public Object getOutFloatFile()

Returns the Output floating point raster file parameter of this tool . This parameter is the output floating-point raster file. the file name must have a .flt extension. This is a required parameter.

Returns:

the Output floating point raster file

setOutFloatFile

public void setOutFloatFile(Object outFloatFile)

Sets the Output floating point raster file parameter of this tool . This parameter is the output floating-point raster file. the file name must have a .flt extension. This is a required parameter.

Parameters:

outFloatFile - the output floating-point raster file. the file name must have a .flt extension.

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