Nothing
#' @title Estimate the coverage probability of a stationary RACS
#' @author Kassel Liam Hingee
#' @importFrom spatstat.random rpoispp
#' @import spatstat.geom
#' @export coveragefrac coverageprob cp
#'
#' @description
#' Computes the proportion of the observation window that is foreground, which is the usual estimate for the coverage probability of a stationary RACS from a binary map.
#'
#' @references Chiu, S.N., Stoyan, D., Kendall, W.S. and Mecke, J. (2013) Stochastic Geometry and Its Applications, 3rd ed. Chichester, United Kingdom: John Wiley & Sons.
#'
#' @param xi An observation of a RACS of interest as a full binary map (as an \code{im} object) or as the foreground set (as an \code{owin} object).
#' In the latter case the observation window, \code{obswin}, must be supplied.
#' @param obswin The window of observation (not necessarily rectangular) also as an \code{owin} object.
#' @return An estimate of the coverage probability
#' @details
#' The coverage probability of a stationary RACS is the probability that an arbitrary point is covered by the RACS.
#' Given a binary map, \code{xi}, of a realisation of stationary RACS \eqn{\Xi} in a window \eqn{W},
#' this function computes the fraction of \eqn{W} covered by foreground,
#' which is an estimate of the coverage probability.
#' See (Chiu et al., 2013, Section 6.4.2) for more details.
#'
#' If \code{xi} is an \code{im} object then \code{xi} must be an image of 1s, 0s and NAs
#' representing inside the set, outside the set and outside the observation window respectively.
#' \code{coverageprob} will not accept a \code{obswin} argument if \code{xi} is an \code{im} object.
#'
#' @examples
#' xi <- heather$coarse
#' obswindow <- Frame(heather$coarse)
#' cp <- coverageprob(xi, obswindow)
#' @keywords spatial nonparametric
coverageprob <- function(xi, obswin = NULL){
if (is.im(xi)){
stopifnot(is.null(obswin))
coverprobest <- sum(xi) / sum(is.finite(xi$v))
return(coverprobest)
}
stopifnot(is.owin(xi))
stopifnot(is.owin(obswin))
xinw <- intersect.owin(xi, obswin)
xiinw_area <- area.owin(xinw)
w_area <- area.owin(obswin)
coverprobest <- xiinw_area / w_area
return(coverprobest)
}
#' @rdname coverageprob
coveragefrac <- coverageprob
#' @rdname coverageprob
cp <- coverageprob
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.