ee.Geometry.difference
Returns the result of subtracting the 'right' geometry from the 'left' geometry.
Usage | Returns |
---|
Geometry.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 Geometry object.
var geometry = ee.Geometry({
'type': 'Polygon',
'coordinates':
[[[-122.081, 37.417],
[-122.086, 37.421],
[-122.084, 37.418],
[-122.089, 37.416]]]
});
// Define other inputs.
var inputGeom = ee.Geometry.BBox(-122.085, 37.415, -122.075, 37.425);
// Apply the difference method to the Geometry object.
var geometryDifference = geometry.difference({'right': inputGeom, 'maxError': 1});
// Print the result to the console.
print('geometry.difference(...) =', geometryDifference);
// Display relevant geometries on the map.
Map.setCenter(-122.085, 37.422, 15);
Map.addLayer(geometry,
{'color': 'black'},
'Geometry [black]: geometry');
Map.addLayer(inputGeom,
{'color': 'blue'},
'Parameter [blue]: inputGeom');
Map.addLayer(geometryDifference,
{'color': 'red'},
'Result [red]: geometry.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 Geometry object.
geometry = ee.Geometry({
'type': 'Polygon',
'coordinates': [[
[-122.081, 37.417],
[-122.086, 37.421],
[-122.084, 37.418],
[-122.089, 37.416],
]],
})
# Define other inputs.
input_geom = ee.Geometry.BBox(-122.085, 37.415, -122.075, 37.425)
# Apply the difference method to the Geometry object.
geometry_difference = geometry.difference(right=input_geom, maxError=1)
# Print the result.
display('geometry.difference(...) =', geometry_difference)
# Display relevant geometries on the map.
m = geemap.Map()
m.set_center(-122.085, 37.422, 15)
m.add_layer(geometry, {'color': 'black'}, 'Geometry [black]: geometry')
m.add_layer(input_geom, {'color': 'blue'}, 'Parameter [blue]: input_geom')
m.add_layer(
geometry_difference, {'color': 'red'}, 'Result [red]: geometry.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."],[[["`difference()` returns a Geometry representing the portion of the first geometry that does not intersect with the second geometry."],["It accepts a 'right' Geometry to subtract and optional `maxError` and `proj` parameters for reprojection control."],["The operation is performed in spherical coordinates with distances in meters on the sphere unless a projection is specified."],["This method is useful for creating new geometries by removing overlapping areas between existing ones."]]],["The `Geometry.difference()` method subtracts a 'right' geometry from a 'left' geometry, returning the result as a new geometry. It accepts the `right` geometry, an optional `maxError` for reprojection tolerance, and an optional `proj` for the operation's projection. If `proj` is not defined the method will use the spherical coordinate system. Example code shows the difference operation using defined geometries and displays the result.\n"]]