TanH (Spatial Analyst)

Available with Spatial Analyst license.

Available with Image Analyst license.

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 -∞ and ∞ represent the smallest negative and largest positive value supported by the particular raster format, respectively.

• The input and output values for this tool are interpreted as unitless.

• Output values are always floating point, regardless of the input data type.

• If the input is a multiband raster, the output will be a multiband raster. The tool will perform the operation on each band in the input.

• See Analysis environments and Spatial Analyst for additional details on the geoprocessing environments that apply to this tool.

Syntax

TanH(in_raster_or_constant)

Parameter	Explanation	Data Type
in_raster_or_constant	The input to calculate the hyperbolic tangent values for. 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

TanH example 1 (Python window)

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")

TanH example 2 (stand-alone script)

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"

# Execute TanH
outTanH = TanH(inRaster)

# Save the output 
outTanH.save("C:/sapyexamples/output/outtanh.img")

Environments

Auto Commit, Cell Size, Cell Size Projection Method, Current Workspace, Extent, Geographic Transformations, Mask, Output CONFIG Keyword, Output Coordinate System, Scratch Workspace, Snap Raster, Tile Size

Licensing information

• Basic: Requires Spatial Analyst or Image Analyst
• Standard: Requires Spatial Analyst or Image Analyst
• Advanced: Requires Spatial Analyst or Image Analyst