ee.ImageCollection.filterBounds

  • filterBounds filters a collection to include only items whose footprint intersects the provided geometry.

  • This function is a shortcut equivalent to using filter(ee.Filter.bounds(...)) .

  • Using a large or complex collection as the geometry argument can negatively impact performance.

  • The function returns the filtered collection.

  • The geometry argument can be a ComputedObject , FeatureCollection , or Geometry .

Shortcut to filter a collection by intersection with geometry. Items in the collection with a footprint that fails to intersect the given geometry will be excluded.

This is equivalent to this.filter(ee.Filter.bounds(...)).

Returns the filtered collection.

Usage Returns
ImageCollection. filterBounds (geometry) Collection
Argument Type Details
this: collection
Collection The Collection instance.
geometry
ComputedObject|FeatureCollection|Geometry The geometry, feature or collection to intersect with.

Examples

Code Editor (JavaScript)

 // A Sentinel-2 surface reflectance image collection for 3 months in 2021. 
 var 
  
 ic 
  
 = 
  
 ee 
 . 
 ImageCollection 
 ( 
 'COPERNICUS/S2_SR' 
 ) 
  
 . 
 filterDate 
 ( 
 '2021-07-01' 
 , 
  
 '2021-10-01' 
 ); 
 // A point geometry for the peak of Mount Shasta, California, USA. 
 var 
  
 geom 
  
 = 
  
 ee 
 . 
 Geometry 
 . 
 Point 
 ( 
 - 
 122.196 
 , 
  
 41.411 
 ); 
 print 
 ( 
 'Images intersecting point geometry' 
 , 
  
 ic 
 . 
 filterBounds 
 ( 
 geom 
 )); 
 // A feature collection of point geometries for mountain peaks. 
 var 
  
 fc 
  
 = 
  
 ee 
 . 
 FeatureCollection 
 ([ 
  
 ee 
 . 
 Feature 
 ( 
 ee 
 . 
 Geometry 
 . 
 Point 
 ( 
 - 
 122.196 
 , 
  
 41.411 
 ), 
  
 { 
 mountain 
 : 
  
 'Mount Shasta' 
 }), 
  
 ee 
 . 
 Feature 
 ( 
 ee 
 . 
 Geometry 
 . 
 Point 
 ( 
 - 
 121.697 
 , 
  
 45.374 
 ), 
  
 { 
 mountain 
 : 
  
 'Mount Hood' 
 }) 
 ]); 
 print 
 ( 
 'Images intersecting feature collection' 
 , 
  
 ic 
 . 
 filterBounds 
 ( 
 fc 
 )); 

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)

 # A Sentinel-2 surface reflectance image collection for 3 months in 2021. 
 ic 
 = 
 ee 
 . 
 ImageCollection 
 ( 
 'COPERNICUS/S2_SR' 
 ) 
 . 
 filterDate 
 ( 
 '2021-07-01' 
 , 
 '2021-10-01' 
 ) 
 # A point geometry for the peak of Mount Shasta, California, USA. 
 geom 
 = 
 ee 
 . 
 Geometry 
 . 
 Point 
 ( 
 - 
 122.196 
 , 
 41.411 
 ) 
 display 
 ( 
 'Images intersecting point geometry:' 
 , 
 ic 
 . 
 filterBounds 
 ( 
 geom 
 )) 
 # A feature collection of point geometries for mountain peaks. 
 fc 
 = 
 ee 
 . 
 FeatureCollection 
 ([ 
 ee 
 . 
 Feature 
 ( 
 ee 
 . 
 Geometry 
 . 
 Point 
 ( 
 - 
 122.196 
 , 
 41.411 
 ), 
 { 
 'mountain' 
 : 
 'Mount Shasta' 
 }), 
 ee 
 . 
 Feature 
 ( 
 ee 
 . 
 Geometry 
 . 
 Point 
 ( 
 - 
 121.697 
 , 
 45.374 
 ), 
 { 
 'mountain' 
 : 
 'Mount Hood' 
 }) 
 ]) 
 display 
 ( 
 'Images intersecting feature collection:' 
 , 
 ic 
 . 
 filterBounds 
 ( 
 fc 
 )) 
Create a Mobile Website
View Site in Mobile | Classic
Share by: