R/n_cells.R

In quadtree: Region Quadtrees for Spatial Data

#' @include generics.R

#' @name n_cells
#' @aliases n_cells,Quadtree-method
#' @title Get the number of cells in a \code{Quadtree}
#' @description Returns the number of nodes/cells in the quadtree.
#' @param x a \code{\link{Quadtree}}
#' @param terminal_only boolean; if \code{TRUE} (the default) only the terminal
#' nodes are counted. If \code{FALSE}, all nodes are counted, thereby giving the
#' total number of nodes in the tree.
#' @return a numeric
#' @examples
#' library(quadtree)
#' habitat <- terra::rast(system.file("extdata", "habitat.tif", package="quadtree"))
#'
#' qt <- quadtree(habitat, .1)
#' n_cells(qt)
#' n_cells(qt, terminal_only = FALSE)
#' @export
setMethod("n_cells", signature(x = "Quadtree"),
  function(x, terminal_only = TRUE) {
    n <- x@ptr$nNodes()
    if (!terminal_only) return(n)
    return((floor(n / 4) * 3) + 1)
  }
)