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

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

All Implemented Interfaces:

GPTool

public class FloatToRaster
extends AbstractGPTool

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

Usage tips:

• The input file is an IEEE floating-point format, 32-bit signed binary file.
• Two inputs are required: the binary floating-point file with a .flt extension (.flt) and an ASCII header file with a .hdr extension (.hdr). You only specify the .flt file; however, there needs to be an existing .hdr file in the same directory with the same file name.
• The ASCII file consists of header information containing a set of keywords.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:
• The NODATA_VALUE is the value in the input file that determines which cells should be assigned the value of NoData in the output raster. NoData is normally reserved for those cells whose true value is unknown.
• In a floating-point binary file, the values are written as binary 32-bit signed floating-point numbers. The first record of the file corresponds to the first row of the raster. Going from left to right, the first 32 bits are the first cell, the next 32 bits are the second cell, and so on, to the end of the record (row). This is repeated for the second record (the second row of the raster) and all the way until the last record (the bottom row of the raster).
• This tool supports both the lower left corner and the center of the lower left cell for determining the origin. only writes the origin as the lower left corner of the lower left cell.

Field Summary

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

vals

Constructor Summary

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

FloatToRaster(Object inFloatFile, Object outRaster)
Creates the Float to Raster tool with the required parameters.

Method Summary

Object	getInFloatFile() Returns the Input floating point raster file 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	setInFloatFile(Object inFloatFile) Sets the Input floating point raster file 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

FloatToRaster

public FloatToRaster()

Creates the Float to Raster tool with defaults.

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

FloatToRaster

public FloatToRaster(Object inFloatFile,
                     Object outRaster)

Creates the Float 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:

inFloatFile - the input floating-point binary file. the file must have a .flt extension. There must be a header file in association with the floating-point binary file, with a .hdr extension.

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

getInFloatFile

public Object getInFloatFile()

Returns the Input floating point raster file parameter of this tool . This parameter is the input floating-point binary file. the file must have a .flt extension. There must be a header file in association with the floating-point binary file, with a .hdr extension. This is a required parameter.

Returns:

the Input floating point raster file

setInFloatFile

public void setInFloatFile(Object inFloatFile)

Sets the Input floating point raster file parameter of this tool . This parameter is the input floating-point binary file. the file must have a .flt extension. There must be a header file in association with the floating-point binary file, with a .hdr extension. This is a required parameter.

Parameters:

inFloatFile - the input floating-point binary file. the file must have a .flt extension. There must be a header file in association with the floating-point binary file, with a .hdr extension.

getOutRaster

public 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(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.

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