Continuous Field Function
A function that returns a ContinuousField when evaluated. Use ContinuousFieldFunction.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).
Calculations that evaluate to infinity or NaN produce an indeterminate value.
Values are represented as 32-bit floating-point numbers, 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 ContinuousFieldFunctions. For example, if a and b are ContinuousFieldFunctions, the following will create a new ContinuousFieldFunction 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 are top level functions as follows:
abs(ContinuousFieldFunction) returns a ContinuousFieldFunction that provides the absolute value of each point across the extent of the given ContinuousFieldFunction's field result, for example:
val d: ContinuousFieldFunction = abs(a - b)
ceil(ContinuousFieldFunction) returns a ContinuousFieldFunction that rounds the given ContinuousFieldFunction's field result upwards to the nearest integer, for example:
val d: ContinuousFieldFunction = ceil(a - b)
floor(ContinuousFieldFunction) returns a ContinuousFieldFunction that rounds the given ContinuousFieldFunction's field result downwards to the nearest integer, for example:
val d: ContinuousFieldFunction = floor(a - b)
round(ContinuousFieldFunction) returns a ContinuousFieldFunction that rounds the given ContinuousFieldFunction's field result to the nearest integer, for example:
val d: ContinuousFieldFunction = round(a - b)
Since
300.0.0
See also
Inheritors
Functions
Composes a function that returns the arccosine of this function's field result across its extent. The function result is the principal value, in radians, of the inverse cosine of the function's field result, so the function result will lie between 0 and pi.
Composes a function that returns the arcsine of this function's field result across its extent. The function result is the principal value, in radians, of the inverse sine of the function's field result, so the function result will lie between -pi/2 and pi/2.
Composes a function that returns the aspect of this function's field result across its extent. Aspect identifies the compass direction that the downhill slope faces at each location.
Composes a function that returns the arctangent of this function's field result across its extent. The function result is the principal value, in radians, of the inverse tangent of the function's field result, so the function result will lie between -pi/2 and pi/2.
Composes a function that clips this function's field result such that it does not extend beyond the provided extent.
Composes a function that clamps, point-wise, this function's field result between two values drawn from two others. The function result is min where this function's field result is less than min. The function result is max where this function's field result is greater than max. Otherwise, this function's field result is preserved.
Composes a function that clamps, point-wise, this function's field result between two values. The function result is min where this function's field result is less than min. The function result is max where this function's field result is greater than max. Otherwise, this function's field result is preserved.
Composes a function that returns the cosine of this function's field result across its extent. The function's field result is in radians.
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.
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.
Evaluates the result of the function. If the data fits in memory, it is processed in a single pass. Larger datasets (typically >2 GB) are split into smaller processing areas to match available hardware, increasing processing time.
Composes a function that returns Euler's number (e) raised 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 returns 10 raised 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 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 and false where it has no data. All values in the result will have 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.
Composes 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 returns the natural logarithm of 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 returns the common logarithm (base 10) of 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 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 returns this function's field result raised to powers drawn from another field, point-wise, across their spatial intersection. The function result has no data where either of the fields have no data.
Composes a function that returns this function's field result raised to a power across its extent. The function result has no data where this function's field result has no data.
Composes a function that returns the reciprocal of 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 applies a % (remainder) operation, point-wise, to this function's field result using values from another field as the divisors across their spatial intersection. The function result has no data where either of the fields have no data.
Composes a function that applies a % (remainder) operation, point-wise, to this function's field result. 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 replaced 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 the selection is 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 the selection is 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 returns the sine of this function's field result across its extent. The function's field result is in radians.
Composes a function that returns the slope of this function's field result across its extent. Slope identifies the steepness of the terrain at each location, expressed in positive degrees from 0 (flat) to 90. To express the result in percent rise, convert the slope angle in degrees using map algebra: Percent rise = 100 * tan(angle * pi/180). Percent rise will range from 0 to infinity, with a flat surface being 0 percent and a 45 degree surface being 100 percent.
Composes a function that returns the square root of 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 returns the tangent of this function's field result across its extent. The function's field result is in radians.
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, float values from this function's field result to integer values across its extent. Values that are within the representable range of a 32-bit signed integer are converted to an integer by discarding the fractional part then cast. Values that are not within the representable range of a 32-bit signed integer are clamped to be within the representable range then converted to an integer by discarding the fractional part then cast. The function result has no data where this function's field result has no data.