focal_sum#
Signature#
- focal_sum(array, kernel) Field#
Sum all values in a neighbourhood
- Parameters:
array (Field) – Arithmetic array to analyse
kernel (Kernel) – Neighbourhood to search. The weights must be integral and will be used to determine whether a cell’s value is to be evaluated (weight is non-zero) or not (weight is zero).
- Returns:
New arithmetic array
Description#
Focal operation summing all values in a neighbourhood.
No-data handling#
As long as there is at least one valid value found within the input neighbourhood, a valid value is written to the focal cell in the output array. Only when no such value is found is a no-data value written. The output array is likely to contain less no-data values than the input array.
Example#
/* TODO */
// TODO
# TODO
See also#
See
convolve()for an operation which sums values, multiplying them by weights