ee.Geometry.Rectangle.contains

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

  • It's applicable to Rectangle geometries and takes the target geometry, allowed error margin, and projection as input parameters.

  • The operation can be performed using a specified projection or defaults to a spherical coordinate system with linear distances measured in meters.

  • Examples are provided in JavaScript, Python, and Colab for demonstrating the usage of the contains method.

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

UsageReturns
Rectangle.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 Rectangle object.
var rectangle = ee.Geometry.Rectangle(-122.09, 37.42, -122.08, 37.43);

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

// Apply the contains method to the Rectangle object.
var rectangleContains = rectangle.contains({'right': inputGeom, 'maxError': 1});

// Print the result to the console.
print('rectangle.contains(...) =', rectangleContains);

// Display relevant geometries on the map.
Map.setCenter(-122.085, 37.422, 15);
Map.addLayer(rectangle,
             {'color': 'black'},
             'Geometry [black]: rectangle');
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 Rectangle object.
rectangle = ee.Geometry.Rectangle(-122.09, 37.42, -122.08, 37.43)

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

# Apply the contains method to the Rectangle object.
rectangle_contains = rectangle.contains(right=input_geom, maxError=1)

# Print the result.
display('rectangle.contains(...) =', rectangle_contains)

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