ee.Number.toInt

Casts the input value to a signed 32-bit integer.

UsageReturns
Number.toInt()Number
ArgumentTypeDetails
this: inputNumberThe input value.

Examples

Code Editor (JavaScript)

// Cast a number to signed 32-bit integer: [-2147483648, 2147483647].
var number = ee.Number(100);
print('Number:', number);

var intNumber = number.toInt();
print('Number cast to int:', intNumber);


/**
 * Casting numbers to int 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 int loses decimal precision.
var float = ee.Number(1.7);
print('Floating point value:', float);

var floatToInt = float.toInt();
print('Floating point value cast to int:', floatToInt);

// A number greater than int range max cast to int becomes int range max.
var INT_MAX = 2147483647;
var outOfRangeHi = ee.Number(INT_MAX + 12345);
print('Greater than int max:', outOfRangeHi);

var outOfRangeHiToInt = outOfRangeHi.toInt();
print('Greater than int max cast to int becomes int max:', outOfRangeHiToInt);

// A number greater than int range min cast to int becomes int range min.
var INT_MIN = -2147483648;
var outOfRangeLo = ee.Number(INT_MIN - 12345);
print('Less than int min:', outOfRangeLo);

var outOfRangeLoToInt = outOfRangeLo.toInt();
print('Less than int min cast to int becomes int min:', outOfRangeLoToInt);

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 signed 32-bit integer: [-2147483648, 2147483647].
number = ee.Number(100)
print('Number:', number.getInfo())

int_number = number.toInt()
print('Number cast to int:', int_number.getInfo())


"""Casting numbers to int 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 int loses decimal precision.
float_number = ee.Number(1.7)
print('Floating point value:', float_number.getInfo())

float_to_int = float_number.toInt()
print('Floating point value cast to int:', float_to_int.getInfo())

# A number greater than int range max cast to int becomes int range max.
INT_MAX = 2147483647
out_of_range_hi = ee.Number(INT_MAX + 12345)
print('Greater than int max:', out_of_range_hi.getInfo())

out_of_range_hi_to_int = out_of_range_hi.toInt()
print('Greater than int max cast to int becomes int max:',
      out_of_range_hi_to_int.getInfo())

# A number greater than int range min cast to int becomes int range min.
INT_MIN = -2147483648
out_of_range_lo = ee.Number(INT_MIN - 12345)
print('Less than int min:', out_of_range_lo.getInfo())

out_of_range_lo_to_int = out_of_range_lo.toInt()
print('Less than int min cast to int becomes int min:',
      out_of_range_lo_to_int.getInfo())