ee.Array.tanh

  • Calculates the hyperbolic tangent of each element in an input array.

  • Returns a new array with the calculated hyperbolic tangent values.

  • Accepts a single argument: the input array.

  • Usable in both JavaScript and Python environments within Google Earth Engine.

 On an element-wise basis, computes the hyperbolic tangent of the input.

UsageReturns
Array.tanh()Array
ArgumentTypeDetails
this: inputArrayThe input array.

Examples

Code Editor (JavaScript)

print(ee.Array([-5]).tanh());  // [~ -1]
print(ee.Array([0]).tanh());  // [0]
print(ee.Array([5]).tanh());  // [~ 1]

var start = -5;
var end = 5;
var points = ee.Array(ee.List.sequence(start, end, null, 50));
var values = points.tanh();

// Plot tanh() defined above.
var chart = ui.Chart.array.values(values, 0, points)
    .setOptions({
      viewWindow: {min: start, max: end},
      hAxis: {
        title: 'x',
        viewWindowMode: 'maximized',
        ticks: [
          {v: start},
          {v: 0},
          {v: end}]
      },
      lineWidth: 1,
      pointSize: 0,
    });
print(chart);

Python setup

See the Python Environment page for information on the Python API and using geemap for interactive development.

import ee
import geemap.core as geemap

Colab (Python)

import altair as alt
import pandas as pd

display(ee.Array([-5]).tanh())  # [~ -1]
display(ee.Array([0]).tanh())  # [0]
display(ee.Array([5]).tanh())  # [~ 1]

start = -5
end = 5
points = ee.Array(ee.List.sequence(start, end, None, 50))
values = points.tanh()

df = pd.DataFrame({'x': points.getInfo(), 'tanh(x)': values.getInfo()})

# Plot tanh() defined above.
alt.Chart(df).mark_line().encode(
    x=alt.X('x'),
    y=alt.Y('tanh(x)', axis=alt.Axis(values=[start, 0, end]))
)