Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.Array.tanh
Stay organized with collections
Save and categorize content based on your preferences.
On an element-wise basis, computes the hyperbolic tangent of the input.
Usage | Returns | Array.tanh() | Array |
Argument | Type | Details | this: input | Array | The 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]))
)
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-10-06 UTC.
[null,null,["Last updated 2023-10-06 UTC."],[[["\u003cp\u003eCalculates the hyperbolic tangent of each element in an input array.\u003c/p\u003e\n"],["\u003cp\u003eReturns a new array with the calculated hyperbolic tangent values.\u003c/p\u003e\n"],["\u003cp\u003eAccepts a single argument: the input array.\u003c/p\u003e\n"],["\u003cp\u003eUsable in both JavaScript and Python environments within Google Earth Engine.\u003c/p\u003e\n"]]],["The core function is `Array.tanh()`, which calculates the hyperbolic tangent of each element in an input array. It accepts an array as input and returns a new array containing the element-wise hyperbolic tangent values. Example usages are demonstrated with inputs of -5, 0, and 5, showing outputs of approximately -1, 0, and 1, respectively. The code provides a visual plot of the function, illustrating the input values and the associated output from -5 to 5.\n"],null,["# ee.Array.tanh\n\nOn an element-wise basis, computes the hyperbolic tangent of the input.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|----------------|---------|\n| Array.tanh`()` | Array |\n\n| Argument | Type | Details |\n|---------------|-------|------------------|\n| this: `input` | Array | The input array. |\n\nExamples\n--------\n\n### Code Editor (JavaScript)\n\n```javascript\nprint(ee.Array([-5]).tanh()); // [~ -1]\nprint(ee.Array([0]).tanh()); // [0]\nprint(ee.Array([5]).tanh()); // [~ 1]\n\nvar start = -5;\nvar end = 5;\nvar points = ee.Array(ee.List.sequence(start, end, null, 50));\nvar values = points.tanh();\n\n// Plot tanh() defined above.\nvar chart = ui.Chart.array.values(values, 0, points)\n .setOptions({\n viewWindow: {min: start, max: end},\n hAxis: {\n title: 'x',\n viewWindowMode: 'maximized',\n ticks: [\n {v: start},\n {v: 0},\n {v: end}]\n },\n lineWidth: 1,\n pointSize: 0,\n });\nprint(chart);\n```\nPython setup\n\nSee the [Python Environment](/earth-engine/guides/python_install) page for information on the Python API and using\n`geemap` for interactive development. \n\n```python\nimport ee\nimport geemap.core as geemap\n```\n\n### Colab (Python)\n\n```python\nimport altair as alt\nimport pandas as pd\n\ndisplay(ee.Array([-5]).tanh()) # [~ -1]\ndisplay(ee.Array([0]).tanh()) # [0]\ndisplay(ee.Array([5]).tanh()) # [~ 1]\n\nstart = -5\nend = 5\npoints = ee.Array(ee.List.sequence(start, end, None, 50))\nvalues = points.tanh()\n\ndf = pd.DataFrame({'x': points.getInfo(), 'tanh(x)': values.getInfo()})\n\n# Plot tanh() defined above.\nalt.Chart(df).mark_line().encode(\n x=alt.X('x'),\n y=alt.Y('tanh(x)', axis=alt.Axis(values=[start, 0, end]))\n)\n```"]]