AI-generated Key Takeaways
-
The
ee.ErrorMargin()function returns an ErrorMargin object with a specified value and unit. -
The function takes two arguments:
value(Float, default: null) representing the maximum error value andunit(String, default: "meters") specifying the unit ('meters', 'projected', or 'infinite'). -
A negative
valueresults in a positive error margin value. -
A sufficiently large
value(e.g., 1e8) will automatically set the unit to 'infinite', while a slightly smaller large value (e.g., 1e7) will retain the 'meters' unit.
| Usage | Returns |
|---|---|
ee.ErrorMargin( value
, unit
)
|
ErrorMargin |
| Argument | Type | Details |
|---|---|---|
value
|
Float, default: null | The maximum error value allowed by the margin. Ignored if the unit is 'infinite'. |
unit
|
String, default: "meters" | The unit of this margin: 'meters', 'projected' or 'infinite'. |
Examples
Code Editor (JavaScript)
// Construct a variety of error margins. print ( ee . ErrorMargin ( 0 )); // unit: meters value: 0 print ( ee . ErrorMargin ( 1 )); // unit: meters value: 1 // Negative margin yields a positive value. print ( ee . ErrorMargin ( - 1 )); // unit: meters value: 1 // Large values are turned into an 'infinite' print ( ee . ErrorMargin ( 1e8 )); // unit: infinite // A very large error margin does not quite trigger infinite, which is 2.0e7. print ( ee . ErrorMargin ( 1e7 )); // unit: meters value: 10000000 // Being explicit about the units of the error margin. print ( ee . ErrorMargin ( 1 , 'meters' )); // unit: meters value: 1 print ( ee . ErrorMargin ( 1 , 'projected' )); // unit: projected value: 1 print ( ee . ErrorMargin ( 1 , 'infinite' )); // unit: infinite
import ee import geemap.core as geemap
Colab (Python)
# Construct a variety of error margins. display ( ee . ErrorMargin ( 0 )) # unit: meters value: 0 display ( ee . ErrorMargin ( 1 )) # unit: meters value: 1 # Negative margin yields a positive value. display ( ee . ErrorMargin ( - 1 )) # unit: meters value: 1 # Large values are turned into an 'infinite' display ( ee . ErrorMargin ( 1e8 )) # unit: infinite # A very large error margin does not quite trigger infinite, which is 2.0e7. display ( ee . ErrorMargin ( 1e7 )) # unit: meters value: 10000000 # Being explicit about the units of the error margin. display ( ee . ErrorMargin ( 1 , 'meters' )) # unit: meters value: 1 display ( ee . ErrorMargin ( 1 , 'projected' )) # unit: projected value: 1 display ( ee . ErrorMargin ( 1 , 'infinite' )) # unit: infinite
