Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.Geometry.BBox.intersection
Stay organized with collections
Save and categorize content based on your preferences.
Returns the intersection of the two geometries.
| Usage | Returns | BBox.intersection(right, maxError, proj) | Geometry |
| 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 intersection method to the BBox object.
var bBoxIntersection = bBox.intersection({'right': inputGeom, 'maxError': 1});
// Print the result to the console.
print('bBox.intersection(...) =', bBoxIntersection);
// 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');
Map.addLayer(bBoxIntersection,
{'color': 'red'},
'Result [red]: bBox.intersection');
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 intersection method to the BBox object.
bbox_intersection = bbox.intersection(right=input_geom, maxError=1)
# Print the result.
display('bbox.intersection(...) =', bbox_intersection)
# 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.add_layer(
bbox_intersection, {'color': 'red'}, 'Result [red]: bbox.intersection'
)
m
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-10-06 UTC.
[null,null,["Last updated 2023-10-06 UTC."],[[["\u003cp\u003e\u003ccode\u003eintersection\u003c/code\u003e returns a Geometry representing the shared area between two geometries.\u003c/p\u003e\n"],["\u003cp\u003eThe operation can be performed using a specified projection or a default spherical coordinate system.\u003c/p\u003e\n"],["\u003cp\u003eAn optional \u003ccode\u003emaxError\u003c/code\u003e parameter controls the tolerance for reprojection errors.\u003c/p\u003e\n"],["\u003cp\u003eThe geometries used in the operation are referred to as \u003ccode\u003eleft\u003c/code\u003e (the calling geometry) and \u003ccode\u003eright\u003c/code\u003e (the input geometry).\u003c/p\u003e\n"]]],["The `intersection` method computes the overlapping area between two geometries. It takes a `right` geometry as input, and optionally `maxError` and `proj` parameters for reprojection. The `left` geometry is the one that is calling the intersection method. The output is a new geometry representing the intersection. The examples show how to use this method in Javascript and Python, defining geometries, computing their intersection, and visualizing the original and resulting geometries.\n"],null,["# ee.Geometry.BBox.intersection\n\nReturns the intersection of the two geometries.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|-----------------------------------------------------|----------|\n| BBox.intersection`(right, `*maxError* `, `*proj*`)` | Geometry |\n\n| Argument | Type | Details |\n|--------------|----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| this: `left` | Geometry | The geometry used as the left operand of the operation. |\n| `right` | Geometry | The geometry used as the right operand of the operation. |\n| `maxError` | ErrorMargin, default: null | The maximum amount of error tolerated when performing any necessary reprojection. |\n| `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. |\n\nExamples\n--------\n\n### Code Editor (JavaScript)\n\n```javascript\n// Define a BBox object.\nvar bBox = ee.Geometry.BBox(-122.09, 37.42, -122.08, 37.43);\n\n// Define other inputs.\nvar inputGeom = ee.Geometry.BBox(-122.085, 37.415, -122.075, 37.425);\n\n// Apply the intersection method to the BBox object.\nvar bBoxIntersection = bBox.intersection({'right': inputGeom, 'maxError': 1});\n\n// Print the result to the console.\nprint('bBox.intersection(...) =', bBoxIntersection);\n\n// Display relevant geometries on the map.\nMap.setCenter(-122.085, 37.422, 15);\nMap.addLayer(bBox,\n {'color': 'black'},\n 'Geometry [black]: bBox');\nMap.addLayer(inputGeom,\n {'color': 'blue'},\n 'Parameter [blue]: inputGeom');\nMap.addLayer(bBoxIntersection,\n {'color': 'red'},\n 'Result [red]: bBox.intersection');\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# Define a BBox object.\nbbox = ee.Geometry.BBox(-122.09, 37.42, -122.08, 37.43)\n\n# Define other inputs.\ninput_geom = ee.Geometry.BBox(-122.085, 37.415, -122.075, 37.425)\n\n# Apply the intersection method to the BBox object.\nbbox_intersection = bbox.intersection(right=input_geom, maxError=1)\n\n# Print the result.\ndisplay('bbox.intersection(...) =', bbox_intersection)\n\n# Display relevant geometries on the map.\nm = geemap.Map()\nm.set_center(-122.085, 37.422, 15)\nm.add_layer(bbox, {'color': 'black'}, 'Geometry [black]: bbox')\nm.add_layer(input_geom, {'color': 'blue'}, 'Parameter [blue]: input_geom')\nm.add_layer(\n bbox_intersection, {'color': 'red'}, 'Result [red]: bbox.intersection'\n)\nm\n```"]]