ee.Number.clamp

  • The clamp function constrains a number to a specified minimum and maximum range.

  • Numbers within the specified range remain unchanged.

  • Numbers greater than the maximum are set to the maximum value.

  • Numbers less than the minimum are set to the minimum value.

 Clamps the value to lie within the range of min to max.

UsageReturns
Number.clamp(min, max)Number
ArgumentTypeDetails
this: numberNumber
minFloatThe minimum value to clamp to.
maxFloatThe maximum value to clamp to.

Examples

Code Editor (JavaScript)

// Numbers within range are unaffected.
print('100 clamped to range [0,255]', ee.Number(100).clamp(0, 255));  // 100

// Numbers greater than max in range are set to max.
print('259 clamped to range [0,255]', ee.Number(259).clamp(0, 255));  // 255

// Numbers less than min in range are set to min.
print('-259 clamped to range [0,255]', ee.Number(-259).clamp(0, 255));  // 0

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)

# Numbers within range are unaffected.
# 100
display('100 clamped to range [0,255]:', ee.Number(100).clamp(0, 255))

# Numbers greater than max in range are set to max.
# 255
display('259 clamped to range [0,255]:', ee.Number(259).clamp(0, 255))

# Numbers less than min in range are set to min.
# 0
display('-259 clamped to range [0,255]:', ee.Number(-259).clamp(0, 255))