ArcMap

ATanH

Available with Spatial Analyst license.

Summary

Calculates the inverse hyperbolic tangent of cells in a raster.

Illustration

ATanH illustration
OutRas = ATanH(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 : -1 < [in_value] < 1

      Note that any input value that is outside this domain will receive NoData on the output raster.

    • The Range is : -∞ < [out_value] < ∞

    Note that here -∞ 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.

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

Syntax

ATanH(in_raster_or_constant)
ParameterExplanationData Type
in_raster_or_constant

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.

Raster Layer; Constant

Return Value

NameExplanationData Type
out_raster

The output raster.

The values are the inverse hyperbolic tangent of the input values.

Raster

Code sample

ATanH example 1 (Python window)

This example calculates the inverse 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"
outATanH = ATanH("degs")
outATanH.save("C:/sapyexamples/output/outatanh")
ATanH example 2 (stand-alone script)

This example calculates the inverse hyperbolic tangent of the values in the input Grid raster.

# Name: ATanH_Ex_02.py
# Description: Calculates the inverse 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
outATanH = ATanH(inRaster)

# Save the output 
outATanH.save("C:/sapyexamples/output/outatanh.img")

Environments

Licensing information

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

Related topics