get_wecoma {comat}R Documentation

Create a weighted co-occurrence matrix (wecoma)

Description

Create a weighted co-occurrence matrix (wecoma)

Usage

get_wecoma(
  x,
  w,
  neighbourhood = 4,
  classes = NULL,
  fun = "mean",
  na_action = "replace"
)

Arguments

x

A matrix with categories

w

A matrix with weights

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.

classes

A vector or a list with the values of selected classes from the x object. It is used to calculate wecoma only for selected classes.

fun

Function to calculate values from adjacent cells to contribute to output matrix, "mean" - calculate average values from adjacent cells of weight matrix, "geometric_mean" - calculate geometric mean values from adjacent cells of weight matrix, or "focal" assign value from the focal cell.

na_action

Decides on how to behave in the presence of missing values in w. Possible options are "replace", "omit", "keep". The default, "replace", replaces missing values with 0, "omit" does not use cells with missing values, and "keep" keeps missing values.

Value

A weighted co-occurrence matrix

Examples

library(comat)
data(raster_x, package = "comat")
data(raster_w, package = "comat")

wom = get_wecoma(raster_x, raster_w)
wom

get_wecoma(raster_x, raster_w, classes = list(c(1, 3)))

[Package comat version 0.9.1 Index]