Boolean
A function that returns a BooleanField when evaluated. Use BooleanFieldFunction.evaluate to compute the result of this function.
Results are updated when changes are made to parameters of this function (or to parameters of functions from which it is composed).
Note that infix functions are provided that allow point-wise logical operations to be done on BooleanFieldFunctions. For example, if broadleafWoodland and coniferousWoodland are BooleanFieldFunctions, the following will create a new BooleanFieldFunction allWoodland, containing point values indicating which points correspond to either type of woodland:
val allWoodland = broadleafWoodland or coniferousWoodland
Similarly, there is an operator function not, to allow logical expressions such as:
val notWoodland = !(broadleafWoodland or coniferousWoodland)
Since
300.0.0
See also
Functions
Composes a function that indicates if, point-wise, both this function's field result and another are true. The function result has no data where both of the given fields have no data, or where one of the fields has no data and the other is true. The result is false where one of the given fields has no data and the other is false.
Composes a function that clips this function's field result such that it does not extend beyond the provided extent.
Evaluate the result of the function.
Composes a function that identifies, point-wise, where this function's field result has data across its extent. The result values are true where this function's field result has data and false where it has no data. All values in the result will have data.
Composes a function that applies a mask to this function's field result. Where the selection is true, values from this function's field result are preserved. Where the selection is false, the field has no data.
Composes a function that indicates if, point-wise, this function's field result is false. The function result has no data where this function's field result has no data.
Composes a function that indicates if, point-wise, either this function's field result or another are true. The function result has no data where both of the given fields have no data or where one of the given fields has no data and the other is false.
Composes a function that preserves values from this function's field result or replaces them with values from another. Values are replaced, point-wise across the spatial intersection of the selection with the union of the two function's field results. The function result extent is the intersection of the selection with the union of this function's field result and the other. Where the selection is true, values from the other field are returned. Where false, values from this function's field result are returned. The function result has no data where the selection or the selected field has no data.
Composes a function that preserves values from this function's field result or replaces them with a constant value, point-wise across the extent of this function's field result based on a selection. Where the selection is true, the specified constant value is returned. Where false, values from this function's field result are returned. The function result has no data where the selection or this function's field result has no data.
Composes a function that casts, point-wise, boolean values from this function's field result to integer values across its extent. Boolean values of true and false become 1 and 0, respectively. The function result has no data where this function's field result has no data.
Composes a function that indicates if, point-wise, either this function's field result or another are true, but not both. The function result has no data where either of the given fields has no data.