windowtotal

windowtotal

Sum of values within a specified square neighbourhood

Result = windowtotal(expression, windowlength)

expression

spatial scalar

windowlength

spatial, non spatial scalar

Result

spatial scalar

Options

--unittrue or --unitcell

--unittrue

windowlength is measured in true length (default)

--unitcell

windowlength is measured in number of cell lengths

Operation

For each cell its windowtotal is computed as follows. A square window with the cell in its centre is defined by windowlength. The windowlength is the length of the window in horizontal and vertical directions. For each cell i which is entirely or partly in the window the fraction of the cell in the window is determined. This is the area of the part of the cell in the window divided by the total area of a cell. Call this fraction(i); let expression(i) be the value on expression of cell i. Now, the windowtotal of the centre cell c is a fraction weighted sum of the values on expression:

\[windowtotal(c) = \sum^n_{i=1} ( fraction(i) * expression(i) )\]

where n is the number of cells which is entirely or partly in the window. For each cell c its windowtotal is computed and assigned to the corresponding cell on Result.

Notes

The cell value on windowlength should be greater than 0, else a missing value is assigned to the corresponding cell on Result.

A cell on windowlength with a missing value results in a missing value on Result at the corresponding cell. However, if a missing value on windowlength occurs in a cell which is not the centre cell of the window the value on expression in that cell is included in the summation of the cell values in the window.

Group

This operation belongs to the group of Neigbourhood operators; window operators

Examples

1. • pcrcalc

   binding

   Result1 = Result1.map;

   Expr = Expr.map;

   initial

   report Result1 = windowtotal( Expr, 6);

   
   

   • python

   Expr = readmap(“Expr.map”)

   Result1 = windowtotal( Expr, 6)

   Result1.map	Expr.map

   
   
2. • pcrcalc

   binding

   Result2 = Result2.map;

   Expr = Expr.map;

   WinLen2 = WinLen2.map;

   initial

   report Result2 = windowtotal( Expr, WinLen2);

   
   

   • python

   Expr = readmap(“Expr.map”)

   WinLen2 = readmap(“WinLen2.map”)

   Result2 = windowtotal( Expr, WinLen2)

   Result2.map	Expr.map	WinLen2.map