Discrete Field Function
A function that returns a DiscreteField when evaluated. Use DiscreteFieldFunction.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).
Values are represented as 32-bit signed integers, so arithmetic operations will wrap at the boundaries of this type.
Note that operator functions are provided, allowing point-wise arithmetic to be done on DiscreteFieldFunctions. For example, if a and b are DiscreteFieldFunctions, the following will create a new DiscreteFieldFunction sum, containing point values each of which is the sum of the equivalent point values in a and b:
val sum = a + b
Note also there is a top level function abs(DiscreteFieldFunction) that returns a DiscreteFieldFunction containing the absolute value of each point across the extent of the given DiscreteFieldFunction's field result, for example:
val d: DiscreteFieldFunction = abs(a - b)
Since
300.0.0
See also
Functions
Composes a function that clips this function's field result such that it does not extend beyond the provided extent.
Composes a function that divides, point-wise, this function's field result by another across their spatial intersection. The function result has no data where either of the given fields has no data, or where the divisor is zero.
Composes a function that divides, point-wise, this function's field result by a value across its extent. The function result has no data where this function's field result has no data, or if the divisor is zero.
Evaluates the result of the function.
Composes a function that identifies, point-wise, where this function's field result has data across its extent. The function result values are true where this function's field result has data.
Composes a function that indicates if, point-wise, this function's field result is equal to another. The function result has no data where either of the given fields has no data.
Composes a function that indicates if, point-wise, this function's field result is equal to a given value. The function result has no data where this function's field result has no data.
Composes a function that indicates if, point-wise, this function's field result is greater than another. The function result has no data where either of the given fields has no data.
Composes a function that indicates if, point-wise, this function's field result is greater than a given value. The function result has no data where this function's field result has no data.
Composes a function that indicates if, point-wise, this function's field result is greater than or equal to another. The function result has no data where either of the given fields has no data.
Composes a function that indicates if, point-wise, this function's field result is greater than or equal to a given value. The function result has no data where this function's field result has no data.
Composes a function that indicates if, point-wise, this function's field result is less than another. The function result has no data where either of the given fields has no data.
Composes a function that indicates if, point-wise, this function's field result is less than a given value. The function result has no data where this function's field result has no data.
Compose a function that indicates if, point-wise, this function's field result is less than or equal to another. The function result has no data where either of the given fields has no data.
Composes a function that indicates if, point-wise, this function's field result is less than or equal to a given value. The function result has no data where this function's field result has no data.
Composes a function that indicates if, point-wise, this function's field result is not equal to another. The function result has no data where either of the given fields has no data.
Composes a function that indicates if, point-wise, this function's field result is not equal to a given value. The function result has no data where this function's field result has no 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. The function result has no data where this function's field result or the selection has no data.
Composes a function that subtracts, point-wise, another field from this function's field result across their spatial intersection. The function result has no data where either of the given fields has no data.
Composes a function that subtracts, point-wise, a value from this function's field result across its extent. The function result has no data where this function's field result has no data.
Composes a function that adds, point-wise, this function's field result and another across their spatial intersection. The function result has no data where either of the given fields has no data.
Composes a function that adds, point-wise, a value to this function's field result across its extent. The function result has no data where this function's field result has no data.
Composes a function that preserves values from this function's field result or replaces them with values from another. Values are determined, point-wise, across the spatial intersection of the selection with the union of the two function's field results. 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. Values are determined, 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 multiplies, point-wise, this function's field result and another across their spatial intersection. The function result has no data where either of the given fields has no data.
Composes a function that multiplies, point-wise, this function's field result by a value across its extent. The function result has no data where this function's field result has no data.
Composes a function that casts, point-wise, integer values from this function's field result to floating-point values across its extent. The function result has no data where this function's field result has no data.