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

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

public class ATanH
extends AbstractGPTool

Calculates the inverse hyperbolic tangent of cells in a raster. The ATanH tool is contained in the Spatial Analyst Tools tool box.

Usage tips:


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

ATanH

public ATanH()
Creates the ATanH tool with defaults.

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


ATanH

public ATanH(Object inRasterOrConstant,
             Object outRaster)
Creates the ATanH 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 for which to calculate the inverse hyperbolic tangent values. 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 values are the inverse hyperbolic tangent of the input values.
Method Detail

getInRasterOrConstant

public Object getInRasterOrConstant()
Returns the Input raster or constant value parameter of this tool . This parameter is the input for which to calculate the inverse hyperbolic tangent values. 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 for which to calculate the inverse hyperbolic tangent values. 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 for which to calculate the inverse hyperbolic tangent values. 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 values are the inverse hyperbolic tangent of the input values. 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 values are the inverse hyperbolic tangent of the input values. This is a required parameter.

Parameters:
outRaster - the output raster. the values are the inverse hyperbolic tangent of the input values.

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