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

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

All Implemented Interfaces:

GPTool

public class Tan
extends AbstractGPTool

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

Usage tips:

• In mathematics, all Trigonometric functions have a defined range of valid input values, called the domain. The output values from each function also has a defined range. For this tool:Note that here -? and ? represent the smallest negative and largest positive value supported by the particular raster format, respectively.Where input values approach odd multiples of pi/2, the output value becomes very large. For example, consider an input value of 3*pi/2, which is approximately 4.71238898038. Calculating the Tan of numbers successively closer to this value show a small change in the input value results in a large change in the output value: 4.71 ? 418.58 4.7123 ? 11,238.43 4.7123889 ? 12,440,179.86
• The input values for this tool are interpreted to be in radians. If the input you wish to use is in degrees, the values must first be divided by the radians-to-degrees conversion factor of 180/pi, or approximately 57.296.See for examples of converting input values that are in degrees to the expected units of radians.
• The output values from Tan are interpreted as unitless.
• Output values are always floating point, regardless of the input data type.
• Due to the range of values, applying a Histogram Equalized stretch renderer can be useful to best see the results.

Field Summary

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

vals

Constructor Summary

Tan()
Creates the Tan tool with defaults.

Tan(Object inRasterOrConstant, Object outRaster)
Creates the Tan 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

Tan

public Tan()

Creates the Tan tool with defaults.

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

Tan

public Tan(Object inRasterOrConstant,
           Object outRaster)

Creates the Tan 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 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 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 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 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 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 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 tangent of the input values. This is a required parameter.

Parameters:

outRaster - the output raster. the values are the 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