ee.Geometry.Point.contains

  • The contains method determines if one geometry fully encloses another, returning true if it does and false otherwise.

  • It's applicable to Point geometries using the syntax Point.contains(right, maxError, proj), where right is the geometry being evaluated for containment.

  • Optional parameters include maxError to specify the error tolerance for reprojection and proj for the projection to use during the operation.

  • The examples demonstrate usage with Point and BBox geometries, showing how to apply the method and interpret the results.

 Returns true if and only if one geometry contains the other.

UsageReturns
Point.contains(right, maxError, proj)Boolean
ArgumentTypeDetails
this: leftGeometryThe geometry used as the left operand of the operation.
rightGeometryThe geometry used as the right operand of the operation.
maxErrorErrorMargin, default: nullThe maximum amount of error tolerated when performing any necessary reprojection.
projProjection, default: nullThe projection in which to perform the operation. If not specified, the operation will be performed in a spherical coordinate system, and linear distances will be in meters on the sphere.

Examples

Code Editor (JavaScript)

// Define a Point object.
var point = ee.Geometry.Point(-122.082, 37.42);

// Define other inputs.
var inputGeom = ee.Geometry.BBox(-122.085, 37.415, -122.075, 37.425);

// Apply the contains method to the Point object.
var pointContains = point.contains({'right': inputGeom, 'maxError': 1});

// Print the result to the console.
print('point.contains(...) =', pointContains);

// Display relevant geometries on the map.
Map.setCenter(-122.085, 37.422, 15);
Map.addLayer(point,
             {'color': 'black'},
             'Geometry [black]: point');
Map.addLayer(inputGeom,
             {'color': 'blue'},
             'Parameter [blue]: inputGeom');

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)

# Define a Point object.
point = ee.Geometry.Point(-122.082, 37.42)

# Define other inputs.
input_geom = ee.Geometry.BBox(-122.085, 37.415, -122.075, 37.425)

# Apply the contains method to the Point object.
point_contains = point.contains(right=input_geom, maxError=1)

# Print the result.
display('point.contains(...) =', point_contains)

# Display relevant geometries on the map.
m = geemap.Map()
m.set_center(-122.085, 37.422, 15)
m.add_layer(point, {'color': 'black'}, 'Geometry [black]: point')
m.add_layer(input_geom, {'color': 'blue'}, 'Parameter [blue]: input_geom')
m