ds_grid_get_disk_mean

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

DS grid get disk mean

 

Syntax:

ds_grid_get_disk_mean(index, xm, ym, r);

ArgumentTypeDescription
indexDS GridThe index of the grid.
xmRealThe x position of the disk on the grid.
ymRealThe y position of the disk on the grid.
rRealThe radius of the disk on the grid.

 

Returns:

Real or String

 

Example:

val = ds_grid_get_disk_mean(grid, 5, 5, 2)

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