TanH (Spatial Analyst)
Summary
Calculates the hyperbolic tangent of cells in a raster.
Illustration
 |
OutRas = TanH(InRas) |
Usage
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:
The Domain is : -∞ < [in_value] < ∞
The Range is : -1 < [out_value] < 1
Note that here -∞ and ∞ represent the smallest negative and largest positive value supported by the particular raster format, respectively.
Output values are always floating point, regardless of the input data type.
-
The input and output values of TanH are interpreted as unitless.
Syntax
| Parameter | Explanation | Data Type |
in_raster_or_constant |
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. | Raster Layer | Constant |
Return Value
| Name | Explanation | Data Type |
| out_raster |
The output raster. The values are the hyperbolic tangent of the input values. | Raster |
Code Sample
This example calculates the hyperbolic tangent of the values in the input GRID raster.
import arcpy
from arcpy import env
from arcpy.sa import *
env.workspace = "C:/sapyexamples/data"
outTanH = TanH("degs")
outTanH.save("C:/sapyexamples/output/outtanh")
This example calculates the hyperbolic tangent of the values in the input GRID raster and outputs an IMG raster.
# Name: TanH_Ex_02.py
# Description: Calculates the hyperbolic tangent of cells in a raster
# Requirements: Spatial Analyst Extension
# Import system modules
import arcpy
from arcpy import env
from arcpy.sa import *
# Set environment settings
env.workspace = "C:/sapyexamples/data"
# Set local variables
inRaster = "degs"
# Check out the ArcGIS Spatial Analyst extension license
arcpy.CheckOutExtension("Spatial")
# Execute TanH
outTanH = TanH(inRaster)
# Save the output
outTanH.save("C:/sapyexamples/output/outtanh.img")