| SGFCMeans {geocmeans} | R Documentation |
SGFCMeans
Description
spatial version of the generalized c-mean algorithm (SGFCMeans)
Usage
SGFCMeans(
data,
nblistw = NULL,
k,
m,
alpha,
beta,
lag_method = "mean",
window = NULL,
maxiter = 500,
tol = 0.01,
standardize = TRUE,
robust = FALSE,
noise_cluster = FALSE,
delta = NULL,
verbose = TRUE,
init = "random",
seed = NULL
)
Arguments
data |
A dataframe with only numerical variables. Can also be a list of rasters (produced by the package raster). In that case, each raster is considered as a variable and each pixel is an observation. Pixels with NA values are not used during the classification. |
nblistw |
A list.w object describing the neighbours typically produced by the spdep package. Required if data is a dataframe, see the parameter window if you use a list of rasters as input. |
k |
An integer describing the number of cluster to find |
m |
A float for the fuzziness degree |
alpha |
A float representing the weight of the space in the analysis (0 is a typical fuzzy-c-mean algorithm, 1 is balanced between the two dimensions, 2 is twice the weight for space) |
beta |
A float for the beta parameter (control speed convergence and classification crispness) |
lag_method |
A string indicating if a classical lag must be used ("mean") or if a weighted median must be used ("median"). When working with rasters, a function can be given (or a string which will be parsed). It will be applied to all the pixels values in the matrix designated by the parameter window and weighted according to the values of this matrix. Typically, to obtain an average of the pixels in a 3x3 matrix one could use the function sum (or "sum") and set the window as: window <- matrix(1/9,nrow = 3, ncol = 3). There is one special case when working with rasters: one can specify "nl" (standing for non-local) which calculated a lagged version of the input rasters, using the inverse of the euclidean distance as spatial weights (see the section Advanced examples in the vignette introduction for more details). |
window |
If data is a list of rasters, then a window must be specified instead of a list.w object. It will be used to calculate a focal function on each raster. The window must be a square numeric matrix with odd dimensions (such 3x3). The values in the matrix indicate the weight to give to each pixel and the centre of the matrix is the centre of the focal function. |
maxiter |
An integer for the maximum number of iterations |
tol |
The tolerance criterion used in the evaluateMatrices function for convergence assessment |
standardize |
A boolean to specify if the variables must be centred and reduced (default = True) |
robust |
A boolean indicating if the "robust" version of the algorithm must be used (see details) |
noise_cluster |
A boolean indicatong if a noise cluster must be added to the solution (see details) |
delta |
A float giving the distance of the noise cluster to each observation |
verbose |
A boolean to specify if the progress should be printed |
init |
A string indicating how the initial centres must be selected. "random" indicates that random observations are used as centres. "kpp" use a distance-based method resulting in more dispersed centres at the beginning. Both of them are heuristic. |
seed |
An integer used for random number generation. It ensures that the starting centres will be the same if the same value is selected. |
Details
The implementation is based on the following article : doi:10.1016/j.dsp.2012.09.016.
the membership matrix (u) is calculated as follow
u_{ik} = \frac{(||x_{k} - v{_i}||^2 -b_k + \alpha||\bar{x_{k}} - v{_i}||^2)^{(-1/(m-1))}}{\sum_{j=1}^c(||x_{k} - v{_j}||^2 -b_k + \alpha||\bar{x_{k}} - v{_j}||^2)^{(-1/(m-1))}}
the centers of the groups are updated with the following formula
v_{i} = \frac{\sum_{k=1}^N u_{ik}^m(x_{k} + \alpha\bar{x_{k}})}{(1 + \alpha)\sum_{k=1}^N u_{ik}^m}
with
vi the center of the group vi
xk the data point k
xk_bar the spatially lagged data point k
b_k = \beta \times min(||x_{k} - v||)
Value
An S3 object of class FCMres with the following slots
Centers: a dataframe describing the final centers of the groups
Belongings: the final membership matrix
Groups: a vector with the names of the most likely group for each observation
Data: the dataset used to perform the clustering (might be standardized)
isRaster: TRUE if rasters were used as input data, FALSE otherwise
k: the number of groups
m: the fuzyness degree
alpha: the spatial weighting parameter (if SFCM or SGFCM)
beta: beta parameter for generalized version of FCM (GFCM or SGFCM)
algo: the name of the algorithm used
rasters: a list of rasters with membership values and the most likely group (if rasters were used)
missing: a boolean vector indicating raster cell with data (TRUE) and with NA (FALSE) (if rasters were used)
maxiter: the maximum number of iterations used
tol: the convergence criterio
lag_method: the lag function used (if SFCM or SGFCM)
nblistw: the neighbours list used (if vector data were used for SFCM or SGFCM)
window: the window used (if raster data were used for SFCM or SGFCM)
Examples
data(LyonIris)
AnalysisFields <-c("Lden","NO2","PM25","VegHautPrt","Pct0_14","Pct_65","Pct_Img",
"TxChom1564","Pct_brevet","NivVieMed")
dataset <- sf::st_drop_geometry(LyonIris[AnalysisFields])
queen <- spdep::poly2nb(LyonIris,queen=TRUE)
Wqueen <- spdep::nb2listw(queen,style="W")
result <- SGFCMeans(dataset, Wqueen,k = 5, m = 1.5, alpha = 1.5, beta = 0.5, standardize = TRUE)