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

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

All Implemented Interfaces:

GPTool

public class RoundDown
extends AbstractGPTool

Returns the next lower whole number for each cell in a raster. The Round Down tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• Input values can be positive or negative.
• The output raster from this tool is always floating point type, regardless of the input value type.
• If a number has any values to the right of the decimal point, the output will be assigned the next lowest whole value. For example:
• 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.

Field Summary

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

vals

Constructor Summary

RoundDown()
Creates the Round Down tool with defaults.

RoundDown(java.lang.Object inRasterOrConstant, java.lang.Object outRaster)
Creates the Round Down tool with the required parameters.

Method Summary

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

RoundDown

public RoundDown()

Creates the Round Down tool with defaults.

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

RoundDown

public RoundDown(java.lang.Object inRasterOrConstant,
                 java.lang.Object outRaster)

Creates the Round Down 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 values to be rounded down. 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 rounding down to the next lower whole number.

Method Detail

getInRasterOrConstant

public java.lang.Object getInRasterOrConstant()

Returns the Input raster or constant value parameter of this tool . This parameter is the input values to be rounded down. 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(java.lang.Object inRasterOrConstant)

Sets the Input raster or constant value parameter of this tool . This parameter is the input values to be rounded down. 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 values to be rounded down. 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 java.lang.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 rounding down to the next lower whole number. 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. the cell values are the input values converted to integers by rounding down to the next lower whole number. This is a required parameter.

Parameters:

outRaster - the output raster. the cell values are the input values converted to integers by rounding down to the next lower whole number.

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