Send feedback
ee.Number.toUint16
Stay organized with collections
Save and categorize content based on your preferences.
Casts the input value to an unsigned 16-bit integer.
Usage Returns Number. toUint16 ()
Number
Argument Type Details this: input
Number The input value.
Examples
Code Editor (JavaScript)
// Cast a number to unsigned 16-bit integer: [0, 65535].
var number = ee . Number ( 100 );
print ( 'Number:' , number );
var uint16Number = number . toUint16 ();
print ( 'Number cast to uint16:' , uint16Number );
/**
* Casting numbers to uint16 that are outside of its range and precision can
* modify the resulting value, note the behavior of the following scenarios.
*/
// A floating point number cast to uint16 loses decimal precision.
var float = ee . Number ( 1.7 );
print ( 'Floating point value:' , float );
var floatToUint16 = float . toUint16 ();
print ( 'Floating point value cast to uint16:' , floatToUint16 );
// A number greater than uint16 range max cast to uint16 becomes uint16 range max.
var UINT16_MAX = 65535 ;
var outOfRangeHi = ee . Number ( UINT16_MAX + 12345 );
print ( 'Greater than uint16 max:' , outOfRangeHi );
var outOfRangeHiToUint16 = outOfRangeHi . toUint16 ();
print ( 'Greater than uint16 max cast to uint16 becomes uint16 max:' , outOfRangeHiToUint16 );
// A number greater than uint16 range min cast to uint16 becomes uint16 range min.
var UINT16_MIN = 0 ;
var outOfRangeLo = ee . Number ( UINT16_MIN - 12345 );
print ( 'Less than uint16 min:' , outOfRangeLo );
var outOfRangeLoToUint16 = outOfRangeLo . toUint16 ();
print ( 'Less than uint16 min cast to uint16 becomes uint16 min:' , outOfRangeLoToUint16 );
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)
# Cast a number to unsigned 16-bit integer: [0, 65535].
number = ee . Number ( 100 )
print ( 'Number:' , number . getInfo ())
uint16_number = number . toUint16 ()
print ( 'Number cast to uint16:' , uint16_number . getInfo ())
"""Casting numbers to uint16 that are outside of its range and precision can
modify the resulting value, note the behavior of the following scenarios.
"""
# A floating point number cast to uint16 loses decimal precision.
float_number = ee . Number ( 1.7 )
print ( 'Floating point value:' , float_number . getInfo ())
float_to_uint16 = float_number . toUint16 ()
print ( 'Floating point value cast to uint16:' , float_to_uint16 . getInfo ())
# A number greater than uint16 range max cast to uint16
# becomes uint16 range max.
UINT16_MAX = 65535
out_of_range_hi = ee . Number ( UINT16_MAX + 12345 )
print ( 'Greater than uint16 max:' , out_of_range_hi . getInfo ())
out_of_range_hi_to_uint16 = out_of_range_hi . toUint16 ()
print ( 'Greater than uint16 max cast to uint16 becomes uint16 max:' ,
out_of_range_hi_to_uint16 . getInfo ())
# A number greater than uint16 range min cast to uint16
# becomes uint16 range min.
UINT16_MIN = 0
out_of_range_lo = ee . Number ( UINT16_MIN - 12345 )
print ( 'Less than uint16 min:' , out_of_range_lo . getInfo ())
out_of_range_lo_to_uint16 = out_of_range_lo . toUint16 ()
print ( 'Less than uint16 min cast to uint16 becomes uint16 min:' ,
out_of_range_lo_to_uint16 . getInfo ())
Send feedback
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 2023-10-06 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-10-06 UTC."],[[["`Number.toUint16()` casts a given Earth Engine Number to an unsigned 16-bit integer."],["The resulting value will be within the range of 0 to 65535, inclusive."],["Numbers outside this range will be clamped to the minimum or maximum value."],["Floating point numbers will lose decimal precision during the conversion."]]],[]]