R/get_cocoma.R

In comat: Creates Co-Occurrence Matrices of Spatial Data

#' Create a co-located co-occurrence matrix (cocoma)
#'
#' @param x A matrix with categories
#' @param y A matrix with categories
#' @param neighbourhood The number of directions in which cell adjacencies are considered as neighbours:
#' 4 (rook's case) or 8 (queen's case). The default is 4.
#' @param classes A list of length 2 with the values of selected classes from the `x` and `y` objects.
#' It is used to calculate cocoma only for selected classes.
#'
#' @return A co-located co-occurrence matrix
#' @export
#'
#' @examples
#' library(comat)
#' data(raster_x, package = "comat")
#' data(raster_x_na, package = "comat")
#'
#' coom = get_cocoma(raster_x, raster_x_na)
#' coom
#'
#' get_cocoma(raster_x, raster_x_na, classes = list(c(1, 2), 3))
get_cocoma = function(x, y, neighbourhood = 4, classes = NULL){

  if (is.null(classes)){
    classes = lapply(list(x, y), get_unique_values, TRUE)
  }

  directions = as.matrix(neighbourhood)

  rcpp_get_cocoma_internal(x, y, directions, classes[[1]], classes[[2]])
}