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

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

public class TanH
extends AbstractGPTool

Calculates the hyperbolic tangent of cells in a raster. The TanH 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
TanH()
          Creates the TanH tool with defaults.
TanH(java.lang.Object inRasterOrConstant, java.lang.Object outRaster)
          Creates the TanH 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

TanH

public TanH()
Creates the TanH tool with defaults.

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


TanH

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

getInRasterOrConstant

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

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

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