ee.Geometry.BBox.difference
Returns the result of subtracting the 'right' geometry from the 'left' geometry.
Usage | Returns |
---|
BBox.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 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 difference method to the BBox object.
var bBoxDifference = bBox.difference({'right': inputGeom, 'maxError': 1});
// Print the result to the console.
print('bBox.difference(...) =', bBoxDifference);
// 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(bBoxDifference,
{'color': 'red'},
'Result [red]: bBox.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 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 difference method to the BBox object.
bbox_difference = bbox.difference(right=input_geom, maxError=1)
# Print the result.
display('bbox.difference(...) =', bbox_difference)
# 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_difference, {'color': 'red'}, 'Result [red]: bbox.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."],[[["Subtracts the area of the 'right' geometry from the 'left' geometry, returning the remaining portion of the 'left' geometry."],["Accepts a 'maxError' parameter to control the tolerance for reprojection errors."],["Can be performed in a specified projection or defaults to a spherical coordinate system with linear distances in meters."],["Returns a new Geometry object representing the resulting difference."]]],["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 operation's projection. If no projection is supplied the operation is performed in a spherical system with distances in meters. The examples show how to compute and visualize this difference with the provided geometry.\n"]]