Learn R Programming

⚠️There's a newer version (1.0.2) of this package.Take me there.

nhppp

nhppp is a package for simulating events from one dimensional nonhomogeneous Poisson point processes (NHPPPs). Its functions are based on three algorithms that provably sample from a target NHPPP: the time-transformation of a homogeneous Poisson process (of intensity one) via the inverse of the integrated intensity function; the generation of a Poisson number of order statistics from a fixed density function; and the thinning of a majorizing NHPPP via an acceptance-rejection scheme.

Installation

You can install the release version of nhppp from CRAN with:

install.packages("nhppp")

You can install the development version of nhppp from GitHub with:

# install.packages("devtools")
devtools::install_github("bladder-ca/nhppp-fast")

Example

These examples use the generic function draw(), which is a wrapper for the packages specific functions.

Consider the time varying intensity function $\lambda(t) = e^{(0.2t)} (1 + \sin t)$, which is a sinusoidal intensity function with an exponential amplitude. To draw samples over the interval $(0, 6\pi]$ execute

l <- function(t) (1 + sin(t)) * exp(0.2 * t)
nhppp::draw(lambda = l, lambda_maj = l(6 * pi), range_t = c(0, 6 * pi)) |>
  head(n = 20)
#>  [1] 1.197587 1.238620 1.497499 1.713629 1.761914 2.256739 2.537528 3.622938
#>  [9] 5.822574 6.064265 6.645696 6.651551 6.684603 6.875765 6.891348 7.130680
#> [17] 7.446557 7.453139 7.545474 7.557381

where lambda_maj is a majorizer constant.

When available, the integrated intensity function $\Lambda(t) = \int_0^t \lambda(s) \ ds$ and its inverse $\Lambda^{-1}(z)$ result in faster simulation times. For this example, $\Lambda(t) = \frac{e^{0.2t}(0.2 \sin t - \cos t)+1}{1.04} + \frac{e^{0.2t} - 1}{0.2}$; $\Lambda^{-1}(z)$ is constructed numerically upfront (or can be calculated numerically by the function, at a computational cost).

L <- function(t) {
  exp(0.2 * t) * (0.2 * sin(t) - cos(t)) / 1.04 +
    exp(0.2 * t) / 0.2 - 4.038462
}
Li <- stats::approxfun(x = L(seq(0, 6 * pi, 10^-3)), y = seq(0, 6 * pi, 10^-3), rule = 2)

nhppp::draw(Lambda = L, Lambda_inv = Li, range_t = c(0, 6 * pi)) |>
  head(n = 20)
#>  [1] 0.01152846 0.23558627 0.32924742 0.49921843 0.63509297 1.36677413
#>  [7] 2.38941548 3.19511655 3.28049866 4.62140995 5.96916564 6.37504015
#> [13] 6.68283108 6.76577784 7.12919141 7.29249262 7.38665270 7.92953383
#> [19] 7.94791744 7.96591106

Function naming conventions

  1. All functions whose name start with ppp or ztppp sample from constant or piecewise constant intensity functions, as described below:
  • Functions whose names start with ppp_[sequential|orderstats] sample event times in an interval with constant intensity functions with the sequential and order statistics algorithms.

  • Function ztppp() samples one or more event times in an interval with constant intensity, i.e., from a zero-truncated Poisson process.

  • Functions ppp_n() and ppp_next_n() sample n events in an interval and the next n event times after a time t0.

  1. All functions whose name starts with draw or vdraw sample from NHPPPs.
  • Functions with names starting with draw_zt sample at least one event in the interval, i.e., from a zero-truncated NHPPP.

  • Functions with names starting with [draw|draw_zt]_intensity[_majorizer] expect an intensity argument. The third part ([_majorizer]) denotes what, if any, majorizer function is used.

  • Functions with names starting with [draw|draw_zt]_cumulative_intensity[_algorithm] expect a cumulative (integrated) intensity argument. The third part ([_algorithm]) denotes the algorithm used, if more than one algorithms are pertinent.

  • Functions with names starting with vdraw are vectorized.

Copy Link

Version

Install

install.packages('nhppp')

Monthly Downloads

306

Version

0.1.3

License

GPL (>= 3)

Issues

Pull Requests

Stars

Forks

Maintainer

Thomas Trikalinos

Last Published

February 2nd, 2024

Functions in nhppp (0.1.3)

mat_cumsum_columns_with_scalar_ceiling

Return matrix with column-wise cumulative sum replacing cells larger than ceil with NA. No checks for arguments is done.
draw_intensity

Simulate from a non homogeneous Poisson Point Process (NHPPP) from (t0, t_max) (thinning method)
draw

Generic function for simulating from NHPPPs given the intensity function or the cumulative intensity function.
draw_cumulative_intensity_inversion

Simulate from a non homogeneous Poisson Point Process (NHPPP) from (t_min, t_max) (inversion method)
draw_sc_step_regular

Sampling from NHPPPs with piecewise constant intensities with same interval lengths (non-vectorized)
draw_sc_linear

Special case: Simulate from a non homogeneous Poisson Point Process (NHPPP) from (t_min, t_max) with linear intensity function (inversion method)
mat_cumsum_columns_with_vector_ceiling

Return matrix with column-wise cumulative sum replacing cells larger than ceil with NA. No checks for arguments is done.
draw_intensity_step

Simulate from a non homogeneous Poisson Point Process (NHPPP) from (t0, t_max) (thinning method) with piecewise constant_majorizer
ztdraw_sc_loglinear

Simulate from a zero-truncated non homogeneous Poisson Point Process (zt-NHPPP) from (t_min, t_max) with a log-linear intensity function (inversion method)
expect_no_error

Helper functions
mat_cumsum_columns

Return matrix with column-wise cumulative sum No checks for arguments is done.
nhppp-package

nhppp: Simulating Nonhomogeneous Poisson Point Processes
ppp_n

Simulate specific number of points from a homogeneous Poisson Point Process over (t_min, t_max]
draw_sc_loglinear

Special case: Simulate from a non homogeneous Poisson Point Process (NHPPP) from (t_min, t_max) with log-linear intensity function (inversion method)
ztppp

Simulate a zero-truncated homogeneous Poisson Point Process over (t_min, t_max]
ztdraw_intensity_step

Simulate from a zero-truncated non homogeneous Poisson Point Process (NHPPP) from (t0, t_max) (thinning method) with piecewise constant_majorizer
rng_stream_runif

Uniform random samples from rstream objects
draw_sc_step

Simulate a piecewise constant-rate Poisson Point Process over (t_min, t_max] (inversion method) The intervals need not have the same length.
ztdraw_sc_linear

Simulate size samples from a zero-truncated non homogeneous Poisson Point Process (zt-NHPPP) from (t_min, t_max) with linear intensity function
compare_ppp_vectors

Check that two ppp vectors Q-Q agree
ppp_next_n

Simulate n events from a homogeneous Poisson Point Process.
ppp_orderstat

Simulate a homogeneous Poisson Point Process over (t_min, t_max] (order statistics method)
ppp_sequential

Simulate a homogeneous Poisson Point Process over (t_min, t_max]
read_code

Read code from text file as string
ztdraw_cumulative_intensity

Simulate from a zero-truncated non homogeneous Poisson Point Process (zt-NHPPP) from (t_min, t_max) (order statistics method)
get_step_majorizer

Piecewise constant (step) majorizer for K-Lipschitz functions over an interval
rng_stream_rexp

Exponential random samples from rstream objects
inverse_with_uniroot

Numerically evaluate the inverse of a function at a specific point
ztdraw_intensity

Simulate size samples from a zero-truncated non homogeneous Poisson Point Process (zt-NHPPP) from (t0, t_max) (thinning method)
rng_stream_rpois

Poisson random samples from rstream objects
simpson_num_integr

Simpson's method to integrate a univariate function.
rng_stream_rztpois

Zero-truncated Poisson random samples from rstream objects
vdraw_sc_step_regular

Vectorized sampling from NHPPPs with piecewise constant intensities with same interval lengths
Lambda_inv_linear_form

Inverse of the definite integral of l = alpha + beta*t at time t
draw_cumulative_intensity_orderstats

Simulate from a non homogeneous Poisson Point Process (NHPPP) from (t_min, t_max) (order statistics method)
Lambda_linear_form

Definite integral of l = alpha + beta*t at time t with L(t0) = 0
check_ppp_sample_validity

Check the validity of a ppp vector.
Lambda_exp_form

Definite integral of l = exp(alpha + beta*t) at time t with L(t0) = 0
inverse_with_uniroot_sorted

Numerically evaluate the inverse of a monotonically increasing continuous function from R to R at specific points.
Lambda_inv_exp_form

Inverse of the definite integral of l = exp(alpha + beta*t) at time t