R/util_rescale.R

In marcosci/landscapetools: Landscape Utility Toolbox

#' util_rescale
#'
#' Linearly rescale element values in a raster to a range between 0 and 1.
#'
#' @param x Raster* object
#'
#' @return Raster* object with values ranging from 0-1
#'
#' @details Rasters generated by \code{nlm_} functions are scaled between 0 and 1 as default, this option can be set to \code{FALSE} if needed.
#'
#' @examples
#' unscaled_landscape <- gradient_landscape + fractal_landscape
#' util_rescale(unscaled_landscape)
#'
#' @aliases util_rescale
#' @rdname util_rescale
#'
#' @export
#'
util_rescale <- function(x) UseMethod("util_rescale")

#' @name util_rescale
#' @export
util_rescale <- function(x) {
  rescaled_NLM <-
    (x - raster::cellStats(x, "min")) /
      (raster::cellStats(x, "max") - raster::cellStats(x, "min"))

  return(rescaled_NLM)
}