ee.Geometry.BBox.contains

  • The contains method returns true if and only if one geometry contains the other.

  • The method is applied to a BBox object and takes a right geometry, optional maxError , and optional proj as arguments.

  • The right argument is the geometry used as the right operand of the operation, while the left operand is the geometry the method is called on.

  • The maxError argument specifies the maximum tolerated error during reprojection, and proj specifies the projection for the operation.

Returns true if and only if one geometry contains the other.
Usage Returns
BBox. contains (right, maxError , proj ) Boolean
Argument Type Details
this: left
Geometry The geometry used as the left operand of the operation.
right
Geometry The geometry used as the right operand of the operation.
maxError
ErrorMargin, default: null The maximum amount of error tolerated when performing any necessary reprojection.
proj
Projection, default: null The 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 contains method to the BBox object. 
 var 
  
 bBoxContains 
  
 = 
  
 bBox 
 . 
 contains 
 ({ 
 'right' 
 : 
  
 inputGeom 
 , 
  
 'maxError' 
 : 
  
 1 
 }); 
 // Print the result to the console. 
 print 
 ( 
 'bBox.contains(...) =' 
 , 
  
 bBoxContains 
 ); 
 // 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 contains method to the BBox object. 
 bbox_contains 
 = 
 bbox 
 . 
 contains 
 ( 
 right 
 = 
 input_geom 
 , 
 maxError 
 = 
 1 
 ) 
 # Print the result. 
 display 
 ( 
 'bbox.contains(...) =' 
 , 
 bbox_contains 
 ) 
 # 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 
Create a Mobile Website
View Site in Mobile | Classic
Share by: