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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.spatialanalysttools.Abs
All Implemented Interfaces:
GPTool

public class Abs
extends AbstractGPTool

Calculates the absolute value of cells in a raster. The Abs tool is contained in the Spatial Analyst Tools tool box.

Software restrictions: none

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Abs()
          Creates the Abs tool with defaults.
Abs(Object inRasterOrConstant, Object outRaster)
          Creates the Abs 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

Abs

public Abs()
Creates the Abs tool with defaults.

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


Abs

public Abs(Object inRasterOrConstant,
           Object outRaster)
Creates the Abs 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 - Composite Geodataset, input raster or constant value to calculate the absolute values for.
outRaster - Raster Dataset, the raster to be created.
Method Detail

getInRasterOrConstant

public Object getInRasterOrConstant()
Returns the Input raster or constant value parameter of this tool . This parameter is Composite Geodataset, input raster or constant value to calculate the absolute values for. 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 Composite Geodataset, input raster or constant value to calculate the absolute values for. This is a required parameter.

Parameters:
inRasterOrConstant - Composite Geodataset, input raster or constant value to calculate the absolute values for.

getOutRaster

public Object getOutRaster()
Returns the Output raster parameter of this tool . This parameter is Raster Dataset, the raster to be created. 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 Raster Dataset, the raster to be created. This is a required parameter.

Parameters:
outRaster - Raster Dataset, the raster to be created.

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