get_boltzmann {belg}R Documentation

Boltzmann entropy of a landscape gradient

Description

Calculates the Boltzmann entropy of a landscape gradient

Usage

get_boltzmann(x, base = "log10", relative = FALSE)

## Default S3 method:
get_boltzmann(x, base = "log10", relative = FALSE)

## S3 method for class 'array'
get_boltzmann(x, base = "log10", relative = FALSE)

## S3 method for class 'RasterLayer'
get_boltzmann(x, base = "log10", relative = FALSE)

## S3 method for class 'RasterStack'
get_boltzmann(x, base = "log10", relative = FALSE)

## S3 method for class 'RasterBrick'
get_boltzmann(x, base = "log10", relative = FALSE)

Arguments

x

RasterLayer, RasterStack, RasterBrick, matrix, or array

base

A logarithm base ("log", "log2" or "log10")

relative

TRUE/FALSE

Details

The method for computing the Boltzmann entropy of a landscape gradient works on integer values that are either positive or equals to zero. This function automatically rounds values to the nearest integer value (rounding halfway cases away from zero) and negative values are shifted to positive values.

Value

a numeric vector

References

Gao, Peichao, Hong Zhang, and Zhilin Li. "A hierarchy-based solution to calculate the configurational entropy of landscape gradients." Landscape Ecology 32.6 (2017): 1133-1146.

Gao, Peichao, Hong Zhang, and Zhilin Li. "An efficient analytical method for computing the Boltzmann entropy of a landscape gradient." Transactions in GIS (2018).

Examples

new_c = c(56, 86, 98, 50, 45, 56, 96, 25,
          15, 55, 85, 69, 12, 52, 25, 56,
          32, 25, 68, 98, 58, 66, 56, 58)

lg = matrix(new_c, nrow = 3, ncol = 8, byrow = TRUE)
get_boltzmann(lg, relative = FALSE, base = "log10")
get_boltzmann(lg, relative = TRUE, base = "log2")
get_boltzmann(lg, relative = TRUE, base = "log")


[Package belg version 0.2.3 Index]