ds_grid_get_mean

This function can be used to find the mean value for all the cells found within the defined region of a grid (all cell values are added together and then divided by the total number of cells that make the region), as shown in the image below:

DS grid get mean

 

Syntax:

ds_grid_get_mean(index, x1, y1, x2, y2);

ArgumentType Description
indexDS Grid The index of the grid.
x1Real The left cell column of the region.
y1Real The top cell row of the region.
x2Real The right cell column of the region.
y2Real The bottom cell row of the region.

 

Returns:

Real or String

 

Example:

val = ds_grid_get_mean(grid, 0, 0, 5, 5)

The above code will set the variable "val" to the mean value contained within the given region of the DS grid indexed in the variable "grid".