ee.Geometry.BBox.containedIn

  • The containedIn() method determines if one geometry is fully contained within another, returning true if it is and false otherwise.

  • This method is applicable to geometries and takes parameters such as the containing geometry (right), an optional error margin (maxError), and an optional projection (proj).

  • If a projection is not specified, calculations default to a spherical coordinate system with linear distances measured in meters on the sphere.

 Returns true if and only if one geometry is contained in the other.

UsageReturns
BBox.containedIn(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 BBox object.
var bBox = ee.Geometry.BBox(-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 containedIn method to the BBox object.
var bBoxContainedIn = bBox.containedIn({'right': inputGeom, 'maxError': 1});

// Print the result to the console.
print('bBox.containedIn(...) =', bBoxContainedIn);

// Display relevant geometries on the map.
Map.setCenter(-122.085, 37.422, 15);
Map.addLayer(bBox,
             {'color': 'black'},
             'Geometry [black]: bBox');
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 BBox object.
bbox = ee.Geometry.BBox(-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 containedIn method to the BBox object.
bbox_contained_in = bbox.containedIn(right=input_geom, maxError=1)

# Print the result.
display('bbox.containedIn(...) =', bbox_contained_in)

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