Stay organized with collectionsSave and categorize content based on your preferences.
Clips an image to a FeatureCollection. The output bands correspond exactly the input bands, except data not covered by the geometry of at least one feature from the collection is masked. The output image retains the metadata of the input image.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-10-06 UTC."],[[["\u003cp\u003eClips an image to the boundaries of a FeatureCollection, masking data outside the features.\u003c/p\u003e\n"],["\u003cp\u003eOutput image retains the original metadata and band structure of the input image.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eclipToCollection()\u003c/code\u003e takes an image and a FeatureCollection as input, returning a clipped image.\u003c/p\u003e\n"],["\u003cp\u003eUseful for focusing analysis on specific geographic regions defined by features.\u003c/p\u003e\n"]]],[],null,["# ee.Image.clipToCollection\n\nClips an image to a FeatureCollection. The output bands correspond exactly the input bands, except data not covered by the geometry of at least one feature from the collection is masked. The output image retains the metadata of the input image.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|--------------------------------------|---------|\n| Image.clipToCollection`(collection)` | Image |\n\n| Argument | Type | Details |\n|---------------|--------|-----------------------------------|\n| this: `input` | Image | The image to clip. |\n| `collection` | Object | The FeatureCollection to clip to. |\n\nExamples\n--------\n\n### Code Editor (JavaScript)\n\n```javascript\n// A digital elevation model.\nvar dem = ee.Image('NASA/NASADEM_HGT/001');\n\n// A FeatureCollection defining Southeast Asia boundary.\nvar fc = ee.FeatureCollection('USDOS/LSIB_SIMPLE/2017')\n .filter('wld_rgn == \"SE Asia\"');\n\n// Clip the DEM by the Southeast Asia boundary FeatureCollection.\nvar demClip = dem.clipToCollection(fc);\nprint('Clipped image retains metadata and band names', demClip);\n\n// Add layers to the map.\nMap.setCenter(110.64, 9.16, 4);\nMap.addLayer(dem, {bands: 'elevation', min: 0, max: 2500}, 'Original DEM');\nMap.addLayer(fc, {color: 'blue'}, 'FeatureCollection');\nMap.addLayer(demClip,\n {bands: 'elevation', min: 0, max: 2500, palette: ['green', 'yellow', 'brown']},\n 'Clipped DEM');\n```\nPython setup\n\nSee the [Python Environment](/earth-engine/guides/python_install) page for information on the Python API and using\n`geemap` for interactive development. \n\n```python\nimport ee\nimport geemap.core as geemap\n```\n\n### Colab (Python)\n\n```python\n# A digital elevation model.\ndem = ee.Image('NASA/NASADEM_HGT/001')\n\n# A FeatureCollection defining Southeast Asia boundary.\nfc = ee.FeatureCollection('USDOS/LSIB_SIMPLE/2017').filter(\n 'wld_rgn == \"SE Asia\"'\n)\n\n# Clip the DEM by the Southeast Asia boundary FeatureCollection.\ndem_clip = dem.clipToCollection(fc)\ndisplay('Clipped image retains metadata and band names', dem_clip)\n\n# Add layers to the map.\nm = geemap.Map()\nm.set_center(110.64, 9.16, 4)\nm.add_layer(dem, {'bands': 'elevation', 'min': 0, 'max': 2500}, 'Original DEM')\nm.add_layer(fc, {'color': 'blue'}, 'FeatureCollection')\nm.add_layer(\n dem_clip,\n {\n 'bands': 'elevation',\n 'min': 0,\n 'max': 2500,\n 'palette': ['green', 'yellow', 'brown'],\n },\n 'Clipped DEM',\n)\nm\n```"]]
