ee.Geometry.Point.containedIn

  • The containedIn method returns true if one geometry is contained within another.

  • The method can be applied to a Point geometry using the syntax Point.containedIn(right, maxError, proj) .

  • The right argument is the geometry being checked for containment, while maxError and proj are optional parameters for error tolerance and projection.

Returns true if and only if one geometry is contained in the other.
Usage Returns
Point. containedIn (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 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 containedIn method to the Point object. 
 var 
  
 pointContainedIn 
  
 = 
  
 point 
 . 
 containedIn 
 ({ 
 'right' 
 : 
  
 inputGeom 
 , 
  
 'maxError' 
 : 
  
 1 
 }); 
 // Print the result to the console. 
 print 
 ( 
 'point.containedIn(...) =' 
 , 
  
 pointContainedIn 
 ); 
 // 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 containedIn method to the Point object. 
 point_contained_in 
 = 
 point 
 . 
 containedIn 
 ( 
 right 
 = 
 input_geom 
 , 
 maxError 
 = 
 1 
 ) 
 # Print the result. 
 display 
 ( 
 'point.containedIn(...) =' 
 , 
 point_contained_in 
 ) 
 # 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 
Create a Mobile Website
View Site in Mobile | Classic
Share by: