Page Summary
-
The
ee.Algorithms.Iffunction selects one of its inputs based on a condition, similar to an if-then-else construct. -
It takes three arguments:
condition,trueCase, andfalseCase. -
The
conditionargument determines which result is returned, and is interpreted as a boolean with specific rules for non-boolean types. -
The function returns the
trueCaseobject if the condition is true and thefalseCaseobject if the condition is false.
| Usage | Returns |
|---|---|
ee.Algorithms.If( condition
, trueCase
, falseCase
)
|
Object |
Argument
Type
Details
condition
Object, default: null
The condition that determines which result is returned. If this is not a boolean, it is interpreted as a boolean by the following rules:
- Numbers that are equal to 0 or a NaN are false.
- Empty strings, lists and dictionaries are false.
- Null is false.
- Everything else is true.
trueCase
Object, default: null
The result to return if the condition is true.
falseCase
Object, default: null
The result to return if the condition is false.
Examples
Code Editor (JavaScript)
print ( ee . Algorithms . If ( false , '*true*' , '*false*' )); // The string "*false*" print ( ee . Algorithms . If ( true , '*true*' , '*false*' )); // The string "*true*" // Consider using remap rather than If for tasks like numbers for classes. print ( ee . Algorithms . If ( ee . String ( 'Tree' ). compareTo ( 'Tree' ), 0 , 1 )); print ( ee . Algorithms . If ( ee . String ( 'NotTree' ). compareTo ( 'Tree' ), 0 , 1 ));
import ee import geemap.core as geemap
Colab (Python)
# The string "*false*" display ( ee . Algorithms . If ( False , '*true*' , '*false*' )) # The string "*true*" display ( ee . Algorithms . If ( True , '*true*' , '*false*' )) # Consider using remap rather than If for tasks like numbers for classes. display ( ee . Algorithms . If ( ee . String ( 'Tree' ) . compareTo ( 'Tree' ), 0 , 1 )) display ( ee . Algorithms . If ( ee . String ( 'NotTree' ) . compareTo ( 'Tree' ), 0 , 1 ))
