check_det_hrz_restr_input: Checks the arguments of det_hrz_restr

In highriskzone: Determining and Evaluating High-Risk Zones

Checks the arguments of det_hrz_restr

Description

For each argument it is checked if it is of a correct value or class.

Usage

check_det_hrz_restr_input(
  ppdata,
  type,
  criterion,
  cutoff,
  hole,
  integratehole,
  obsprobs,
  obsprobimage,
  distancemap,
  intens,
  nxprob,
  covmatrix,
  returnintens
)

Arguments

ppdata	Observed spatial point process of class ppp.
type	Method to use, can be one of "dist"(method of fixed radius or quantile-based method), or "intens"(intensity based method)
criterion	criterion to limit the high-risk zone, can be one of "area" (giving size of hrz), "indirect" (giving quantile/alpha depending on type), or "direct" (giving radius/threshold c depending on type)
cutoff	Value of criterion (area, radius, quantile, alpha or threshold). Depending on criterion and type.
hole	(optional) an object of class owin representing a region inside the observation window of the ppdata where no observations were possible.
integratehole	Should the hole be part of the resulting high-risk zone? Defaults to TRUE.
obsprobs	(optional) Vector of observation probabilities associated with the observations contained in ppdata. Must be given in the same order as the coordinates of the observations. Only meaningful for the intensity-based method if some observations are located in areas where not all events can actually be observed. For example, if only one third of the events in a specific region could be observed, the observation probability of the corresponding observations is 1/3.
obsprobimage	(optional) an object of class im giving the observation probabilities inside the observation window. Ranges of the coordinates must equal those of ppdata. Only used if obsprobs is not given.
distancemap	(optional) distance map: distance of every pixel to the nearest observation of the point pattern; only needed for type="dist". If not given, it will be computed by distmap.
intens	(optional) estimated intensity of the observed process (object of class "im", see density.ppp), only needed for type="intens". If not given, it will be estimated.
nxprob	Probability of having unobserved events. Default value is 0.1.
covmatrix	(optional) Covariance matrix of the kernel of a normal distribution, only needed for type="intens" if no intensity is given. If not given, it will be estimated.
returnintens	Should the image of the estimated intensity be returned? Defaults to TRUE.

highriskzone documentation built on Aug. 29, 2023, 5:10 p.m.