AI-generated Key Takeaways
-
Image.clipToCollectionclips an image to a FeatureCollection, masking data not covered by the feature collection's geometry. -
The output image retains the metadata and band names of the input image.
-
This method is available in both JavaScript and Python APIs.
| Usage | Returns |
|---|---|
Image.
clipToCollection
(collection)
|
Image |
| Argument | Type | Details |
|---|---|---|
|
this:
input
|
Image | The image to clip. |
collection
|
Object | The FeatureCollection to clip to. |
Examples
Code Editor (JavaScript)
// A digital elevation model. var dem = ee . Image ( 'NASA/NASADEM_HGT/001' ); // A FeatureCollection defining Southeast Asia boundary. var fc = ee . FeatureCollection ( 'USDOS/LSIB_SIMPLE/2017' ) . filter ( 'wld_rgn == "SE Asia"' ); // Clip the DEM by the Southeast Asia boundary FeatureCollection. var demClip = dem . clipToCollection ( fc ); print ( 'Clipped image retains metadata and band names' , demClip ); // Add layers to the map. Map . setCenter ( 110.64 , 9.16 , 4 ); Map . addLayer ( dem , { bands : 'elevation' , min : 0 , max : 2500 }, 'Original DEM' ); Map . addLayer ( fc , { color : 'blue' }, 'FeatureCollection' ); Map . addLayer ( demClip , { bands : 'elevation' , min : 0 , max : 2500 , palette : [ 'green' , 'yellow' , 'brown' ]}, 'Clipped DEM' );
import ee import geemap.core as geemap
Colab (Python)
# A digital elevation model. dem = ee . Image ( 'NASA/NASADEM_HGT/001' ) # A FeatureCollection defining Southeast Asia boundary. fc = ee . FeatureCollection ( 'USDOS/LSIB_SIMPLE/2017' ) . filter ( 'wld_rgn == "SE Asia"' ) # Clip the DEM by the Southeast Asia boundary FeatureCollection. dem_clip = dem . clipToCollection ( fc ) display ( 'Clipped image retains metadata and band names' , dem_clip ) # Add layers to the map. m = geemap . Map () m . set_center ( 110.64 , 9.16 , 4 ) m . add_layer ( dem , { 'bands' : 'elevation' , 'min' : 0 , 'max' : 2500 }, 'Original DEM' ) m . add_layer ( fc , { 'color' : 'blue' }, 'FeatureCollection' ) m . add_layer ( dem_clip , { 'bands' : 'elevation' , 'min' : 0 , 'max' : 2500 , 'palette' : [ 'green' , 'yellow' , 'brown' ], }, 'Clipped DEM' , ) m
