ee.Number.clamp

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 
 ()) 
Create a Mobile Website
View Site in Mobile | Classic
Share by: