ee.Number.signum

  • signum() determines whether an input number is positive, negative, or zero.

  • It returns 1 if the input is positive, -1 if negative, and 0 if zero.

  • The function operates on Earth Engine Number objects and returns a new Number object.

  • Examples demonstrate its usage in JavaScript, Python, and Colab environments.

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.

UsageReturns
Number.signum()Number
ArgumentTypeDetails
this: inputNumberThe 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