ATanH (Image Analyst)

Available with Spatial Analyst license.

Available with Image Analyst license.

Summary

Calculates the inverse hyperbolic tangent of cells in a raster.

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 following are true:

  • 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 -∞ 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.

• In ArcPy, if the input is a multidimensional raster, all slices from all variables will be processed, and the output will be a multidimensional raster.

Parameters

Dialog

Label	Explanation	Data Type
Input raster or constant value	The input for which to calculate the inverse hyperbolic tangent values. 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

Label	Explanation	Data Type
Output raster	The output raster. The values are the inverse hyperbolic tangent of the input values.	Raster

Python

ATanH(in_raster_or_constant)

Name	Explanation	Data Type
in_raster_or_constant	The input for which to calculate the inverse hyperbolic tangent values. 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 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.ia import *
env.workspace = "C:/iapyexamples/data"
outATanH = ATanH("degs")
outATanH.save("C:/iapyexamples/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 pixels 
#    in a raster
# Requirements: Image Analyst Extension

# Import system modules
import arcpy
from arcpy import env
from arcpy.ia import *

# Set environment settings
env.workspace = "C:/iapyexamples/data"

# Set local variables
inRaster = "degs"

# Check out the ArcGIS Image Analyst extension license
arcpy.CheckOutExtension("ImageAnalyst")

# Execute TanH
outATanH = ATanH(inRaster)

# Save the output 
outATanH.save("C:/iapyexamples/output/outatanh.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 Image Analyst or Spatial Analyst
• Standard: Requires Image Analyst or Spatial Analyst
• Advanced: Requires Image Analyst or Spatial Analyst