ee.Number.toUint16

  • Number.toUint16() casts a number to an unsigned 16-bit integer with a range of [0, 65535].

  • Casting a floating point number to uint16 removes its decimal precision.

  • Numbers outside the uint16 range, when cast, become the closest value within the range (0 or 65535).

 Casts the input value to an unsigned 16-bit integer.

UsageReturns
Number.toUint16()Number
ArgumentTypeDetails
this: inputNumberThe 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)
display('Number:', number)

uint16_number = number.toUint16()
display('Number cast to uint16:', uint16_number)


"""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)
display('Floating point value:', float_number)

float_to_uint16 = float_number.toUint16()
display('Floating point value cast to uint16:', float_to_uint16)

# 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)
display('Greater than uint16 max:', out_of_range_hi)

out_of_range_hi_to_uint16 = out_of_range_hi.toUint16()
display('Greater than uint16 max cast to uint16 becomes uint16 max:',
      out_of_range_hi_to_uint16)

# 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)
display('Less than uint16 min:', out_of_range_lo)

out_of_range_lo_to_uint16 = out_of_range_lo.toUint16()
display('Less than uint16 min cast to uint16 becomes uint16 min:',
      out_of_range_lo_to_uint16)