ee.Geometry.Polygon.difference
Returns the result of subtracting the 'right' geometry from the 'left' geometry.
Usage | Returns |
---|
Polygon.difference(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
// Define a Polygon object.
var polygon = ee.Geometry.Polygon(
[[[-122.092, 37.424],
[-122.086, 37.418],
[-122.079, 37.425],
[-122.085, 37.423]]]);
// Define other inputs.
var inputGeom = ee.Geometry.BBox(-122.085, 37.415, -122.075, 37.425);
// Apply the difference method to the Polygon object.
var polygonDifference = polygon.difference({'right': inputGeom, 'maxError': 1});
// Print the result to the console.
print('polygon.difference(...) =', polygonDifference);
// Display relevant geometries on the map.
Map.setCenter(-122.085, 37.422, 15);
Map.addLayer(polygon,
{'color': 'black'},
'Geometry [black]: polygon');
Map.addLayer(inputGeom,
{'color': 'blue'},
'Parameter [blue]: inputGeom');
Map.addLayer(polygonDifference,
{'color': 'red'},
'Result [red]: polygon.difference');
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
# Define a Polygon object.
polygon = ee.Geometry.Polygon([[
[-122.092, 37.424],
[-122.086, 37.418],
[-122.079, 37.425],
[-122.085, 37.423],
]])
# Define other inputs.
input_geom = ee.Geometry.BBox(-122.085, 37.415, -122.075, 37.425)
# Apply the difference method to the Polygon object.
polygon_difference = polygon.difference(right=input_geom, maxError=1)
# Print the result.
display('polygon.difference(...) =', polygon_difference)
# Display relevant geometries on the map.
m = geemap.Map()
m.set_center(-122.085, 37.422, 15)
m.add_layer(polygon, {'color': 'black'}, 'Geometry [black]: polygon')
m.add_layer(input_geom, {'color': 'blue'}, 'Parameter [blue]: input_geom')
m.add_layer(
polygon_difference, {'color': 'red'}, 'Result [red]: polygon.difference'
)
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."],[[["Returns a Geometry representing the portion of the 'left' geometry that does not intersect with the 'right' geometry."],["Accepts a 'right' Geometry, an optional 'maxError' for reprojection, and an optional 'proj' for the operation's coordinate system."],["Performs the difference operation in a spherical coordinate system with distances in meters on the sphere if no projection is specified."],["Can be applied to Polygon geometries to calculate the geometric difference between them."]]],["The `difference` method subtracts a 'right' geometry from a 'left' geometry, returning the resulting geometry. It accepts the 'right' geometry, an optional `maxError` for reprojection tolerance, and an optional `proj` for the projection. The operation can be performed in a spherical coordinate system, with linear distances in meters if `proj` is not defined. The examples illustrate using this function with a polygon and a bounding box, showing the geometries in both the JavaScript code editor and the Colab environment.\n"]]