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

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

All Implemented Interfaces:

GPTool

public class Int
extends AbstractGPTool

Converts each cell value of a raster to an integer by truncation. The Int tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• Integer rasters cannot have values larger than 2,147,483,647 (maximum size determined by 231 – 1), or smaller than -2,147,483,648 (minimum size determined by 231). If Int is used on a floating-point raster in which any value is outside this range, all of the cells in the resulting raster will be NoData.
• The input values can be either positive or negative.
• If rounding is preferred to truncating, add a 0.5 input raster prior to performing the operation.
• There is a difference between the Int tool and the Round Down tool. For example, given the following two values Int always truncates the number:
  • 1.5 becomes 1
  • -1.5 becomes -1
  while for the same two values, Round Down returns:
  • 1.5 becomes 1.0
  • -1.5 becomes -2.0
  Another difference is that Round Down outputs floating-point values, while Int only outputs integer values.
• Storing categorical (discrete) data as an integer raster will use significantly less disk space than the same information stored as a floating-point raster. Whenever possible, it is recommended to convert floating-point rasters to integer with this tool.

Field Summary

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

vals

Constructor Summary

Int()
Creates the Int tool with defaults.

Int(Object inRasterOrConstant, Object outRaster)
Creates the Int tool with the required parameters.

Method Summary

Object	getInRasterOrConstant() Returns the Input raster or constant value 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	setInRasterOrConstant(Object inRasterOrConstant) Sets the Input raster or constant value 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

Int

public Int()

Creates the Int tool with defaults.

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

Int

public Int(Object inRasterOrConstant,
           Object outRaster)

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

inRasterOrConstant - the input raster to be converted to integer. in order to use a number as an input for this parameter, the cell size and extent must first be set in the environment.

outRaster - the output raster. the cell values are the input values converted to integers by truncation.

Method Detail

getInRasterOrConstant

public Object getInRasterOrConstant()

Returns the Input raster or constant value parameter of this tool . This parameter is the input raster to be converted to integer. in order to use a number as an input for this parameter, the cell size and extent must first be set in the environment. This is a required parameter.

Returns:

the Input raster or constant value

setInRasterOrConstant

public void setInRasterOrConstant(Object inRasterOrConstant)

Sets the Input raster or constant value parameter of this tool . This parameter is the input raster to be converted to integer. in order to use a number as an input for this parameter, the cell size and extent must first be set in the environment. This is a required parameter.

Parameters:

inRasterOrConstant - the input raster to be converted to integer. in order to use a number as an input for this parameter, the cell size and extent must first be set in the environment.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output raster. the cell values are the input values converted to integers by truncation. 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. the cell values are the input values converted to integers by truncation. This is a required parameter.

Parameters:

outRaster - the output raster. the cell values are the input values converted to integers by truncation.

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