Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.Number.clamp
Stay organized with collections
Save and categorize content based on your preferences.
Clamps the value to lie within the range of min to max.
| Usage | Returns | Number.clamp(min, max) | Number |
| Argument | Type | Details | this: number | Number | |
min | Float | The minimum value to clamp to. |
max | Float | The 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
print('100 clamped to range [0,255]:', ee.Number(100).clamp(0, 255).getInfo())
# Numbers greater than max in range are set to max.
# 255
print('259 clamped to range [0,255]:', ee.Number(259).clamp(0, 255).getInfo())
# Numbers less than min in range are set to min.
# 0
print('-259 clamped to range [0,255]:', ee.Number(-259).clamp(0, 255).getInfo())
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-09-19 UTC.
[null,null,["Last updated 2024-09-19 UTC."],[[["\u003cp\u003e\u003ccode\u003eNumber.clamp()\u003c/code\u003e constrains a number to a specified range, returning the original number if it falls within the range.\u003c/p\u003e\n"],["\u003cp\u003eIf the number exceeds the maximum value of the range, the function returns the maximum value instead.\u003c/p\u003e\n"],["\u003cp\u003eIf the number is less than the minimum value of the range, the function returns the minimum value.\u003c/p\u003e\n"],["\u003cp\u003eThis function is useful for ensuring that numeric values stay within desired bounds.\u003c/p\u003e\n"]]],["The `clamp(min, max)` function restricts a number within a specified range. It accepts a number, a minimum (`min`), and a maximum (`max`) value as arguments. If the number falls within the `min` and `max` range, it remains unchanged. Numbers exceeding `max` are set to `max`, and those below `min` are set to `min`. The function returns a number. Example, `100` within the range of `0,255` will stay as `100`, while `259` becomes `255` and `-259` becomes `0` in the same range.\n"],null,["# ee.Number.clamp\n\nClamps the value to lie within the range of min to max.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|--------------------------|---------|\n| Number.clamp`(min, max)` | Number |\n\n| Argument | Type | Details |\n|----------------|--------|--------------------------------|\n| this: `number` | Number | |\n| `min` | Float | The minimum value to clamp to. |\n| `max` | Float | The maximum value to clamp to. |\n\nExamples\n--------\n\n### Code Editor (JavaScript)\n\n```javascript\n// Numbers within range are unaffected.\nprint('100 clamped to range [0,255]', ee.Number(100).clamp(0, 255)); // 100\n\n// Numbers greater than max in range are set to max.\nprint('259 clamped to range [0,255]', ee.Number(259).clamp(0, 255)); // 255\n\n// Numbers less than min in range are set to min.\nprint('-259 clamped to range [0,255]', ee.Number(-259).clamp(0, 255)); // 0\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\n# Numbers within range are unaffected.\n# 100\nprint('100 clamped to range [0,255]:', ee.Number(100).clamp(0, 255).getInfo())\n\n# Numbers greater than max in range are set to max.\n# 255\nprint('259 clamped to range [0,255]:', ee.Number(259).clamp(0, 255).getInfo())\n\n# Numbers less than min in range are set to min.\n# 0\nprint('-259 clamped to range [0,255]:', ee.Number(-259).clamp(0, 255).getInfo())\n```"]]