Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.Number.signum
Stay organized with collections
Save and categorize content based on your preferences.
Computes the signum function (sign) of the input; 0 if the input is 0, 1 if the input is greater than 0, -1 if the input is less than 0.
| Usage | Returns | Number.signum() | Number |
| Argument | Type | Details | this: input | Number | The input value. |
Examples
Code Editor (JavaScript)
print('Sign of -5', ee.Number(-5).signum()); // -1
print('Sign of 0', ee.Number(0).signum()); // 0
print('Sign of 5', ee.Number(5).signum()); // 1
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)
print('Sign of -5:', ee.Number(-5).signum().getInfo()) # -1
print('Sign of 0:', ee.Number(0).signum().getInfo()) # 0
print('Sign of 5:', ee.Number(5).signum().getInfo()) # 1
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 2024-07-13 UTC.
[null,null,["Last updated 2024-07-13 UTC."],[[["\u003cp\u003e\u003ccode\u003esignum()\u003c/code\u003e determines whether an input number is positive, negative, or zero.\u003c/p\u003e\n"],["\u003cp\u003eIt returns 1 if the input is positive, -1 if negative, and 0 if zero.\u003c/p\u003e\n"],["\u003cp\u003eThe function operates on Earth Engine \u003ccode\u003eNumber\u003c/code\u003e objects and returns a new \u003ccode\u003eNumber\u003c/code\u003e object.\u003c/p\u003e\n"],["\u003cp\u003eExamples demonstrate its usage in JavaScript, Python, and Colab environments.\u003c/p\u003e\n"]]],["The `signum()` function determines the sign of a numerical input. It returns 0 if the input is 0, 1 if the input is positive, and -1 if the input is negative. The function operates on a single numerical input (`this: input`). Examples demonstrate its usage in both JavaScript and Python, showing the expected outputs for negative, zero, and positive inputs. It uses `ee.Number` for both environments.\n"],null,["# ee.Number.signum\n\nComputes the signum function (sign) of the input; 0 if the input is 0, 1 if the input is greater than 0, -1 if the input is less than 0.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|-------------------|---------|\n| Number.signum`()` | Number |\n\n| Argument | Type | Details |\n|---------------|--------|------------------|\n| this: `input` | Number | The input value. |\n\nExamples\n--------\n\n### Code Editor (JavaScript)\n\n```javascript\nprint('Sign of -5', ee.Number(-5).signum()); // -1\nprint('Sign of 0', ee.Number(0).signum()); // 0\nprint('Sign of 5', ee.Number(5).signum()); // 1\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\nprint('Sign of -5:', ee.Number(-5).signum().getInfo()) # -1\nprint('Sign of 0:', ee.Number(0).signum().getInfo()) # 0\nprint('Sign of 5:', ee.Number(5).signum().getInfo()) # 1\n```"]]