ATanH (Spatial Analyst)

Summary

Calculates the inverse hyperbolic tangent of cells in a raster.

Illustration

ATanH illustration
OutRas = ATanH(InRas)

Usage

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
# Author: ESRI

# 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

Related Topics

Licensing Information

ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Requires Spatial Analyst

6/29/2011