Aindex {SpatialVx} | R Documentation |
Area Index
Description
Calculate Area index described in AghaKouchak et al. (2011).
Usage
Aindex(x, thresh = NULL, dx = 1, dy = 1, ...)
## Default S3 method:
Aindex(x, thresh = NULL, dx = 1, dy = 1, ...)
## S3 method for class 'SpatialVx'
Aindex(x, thresh = NULL, dx = 1, dy = 1, ...,
time.point=1, obs = 1, model=1)
Arguments
x |
Default: m by n numeric matrix giving the field for which the area index is to be calculated.
|
thresh |
Values under this threshold are set to zero. If NULL, it will be set to 1e-8 (a very small value). |
dx , dy |
numeric giving the grid point size in each direction if it is desired to apply such a correction. However, the values are simply canceled out in the index, so these arguments are probably not necessary. If it is desired to only get the area of the non-zero values in the field, or the convex hull, then these make sense. |
time.point |
numeric or character indicating which time point from the “SpatialVx” verification set to select for analysis. |
obs , model |
numeric indicating which observation/forecast model to select for the analysis. |
... |
Not used. |
Details
The area index introduced in AghaKouchak et al. (2011) is given by
Aindex = A/Aconvex,
where A is the area of the pattern, and Aconvex the area of its convex hull (area.owin from package spatstat is used to calculate this latter area, and the functions as.im and solutionset from spatstat are also used by this function). Values are between 0 and 1. Values closer to unity indicate a more structured pattern, and values closer to zero indicate higher dispersiveness of the pattern, but note that two highly structured patterns far away from each other may also give a low value (see examples below). Because of this property, this measure is perhaps best applied to individual features in a field.
Value
numeric vector (or two-row matrix in the case of Aindex.SpatialVx
) with named components (columns):
Aindex |
numeric giving the area index. |
A , Aconvex |
numeric giving the area of th epattern and the convex hull, resp. |
dx , dy |
the values of dx and dy as input to the function. |
Author(s)
Eric Gilleland
References
AghaKouchak, A., Nasrollahi, N., Li, J., Imam, B. and Sorooshian, S. (2011) Geometrical characterization of precipitation patterns. J. Hydrometeorology, 12, 274–285, doi:10.1175/2010JHM1298.1.
See Also
as.im
, solutionset
, convexhull
, Cindex
, Sindex
Examples
# Gemetric shape that is highly structured.
# Re-create Fig. 7a from AghaKouchak et al. (2011).
tmp <- matrix(0, 8, 8)
tmp[3,2:4] <- 1
tmp[5,4:6] <- 1
tmp[7,6:7] <- 1
Aindex(tmp)