This package is considered a duplicate. The official version of this package is found at:https://fcheysson.r-universe.dev/hawkesbow

Package: hawkesbow 1.0.3

Felix Cheysson

hawkesbow: Estimation of Hawkes Processes from Binned Observations

Implements an estimation method for Hawkes processes when count data are only observed in discrete time, using a spectral approach derived from the Bartlett spectrum, see Cheysson and Lang (2020) <arxiv:2003.04314>. Some general use functions for Hawkes processes are also included: simulation of (in)homogeneous Hawkes process, maximum likelihood estimation, residual analysis, etc.

Authors:Felix Cheysson [aut, cre]

hawkesbow_1.0.3.tar.gz
hawkesbow_1.0.3.tar.gz(r-4.5-noble)hawkesbow_1.0.3.tar.gz(r-4.4-noble)
hawkesbow_1.0.3.tgz(r-4.4-emscripten)hawkesbow_1.0.3.tgz(r-4.3-emscripten)
hawkesbow.pdf |hawkesbow.html✨
hawkesbow/json (API)

# Install 'hawkesbow' in R:

install.packages('hawkesbow', repos = c('https://cran.r-universe.dev', 'https://cloud.r-project.org'))

Uses libs:

c++– GNU Standard C++ Library v3
openmp– GCC OpenMP (GOMP) support library

On CRAN:

This package does not link to any Github/Gitlab/R-forge repository. No issue tracker or development information is available.

cpp openmp

2.70 score 1 stars 281 downloads 24 exports 4 dependencies

Last updated 1 years agofrom:7c6f8138cd. Checks:1 OK, 2 WARNING. Indexed: no.

Target	Result	Latest binary
Doc / Vignettes	OK	Mar 08 2025
R-4.5-linux-x86_64	WARNING	Mar 08 2025
R-4.4-linux-x86_64	WARNING	Mar 08 2025

Exports:compensator discrete dpowerlaw E1_imaginary Etheta_imaginary Exponential Gaussian hawkes hawkes_ogata inc_gamma_imag inhpois intensity mle Model Pareto1 Pareto2 Pareto3 PowerLaw ppowerlaw qpowerlaw residuals rpowerlaw SymmetricExponential whittle

Dependencies:BH nloptr Rcpp RcppArmadillo

hawkesbow

Felix Cheysson

Rendered fromhawkesbow.Rmdusingknitr::rmarkdownon Mar 08 2025.

Last update: 2024-01-13
Started: 2021-03-31

Citation

To cite package ‘hawkesbow’ in publications use:

Cheysson F (2024). hawkesbow: Estimation of Hawkes Processes from Binned Observations. R package version 1.0.3, https://CRAN.R-project.org/package=hawkesbow.

Corresponding BibTeX entry:

  @Manual{,
    title = {hawkesbow: Estimation of Hawkes Processes from Binned
      Observations},
    author = {Felix Cheysson},
    year = {2024},
    note = {R package version 1.0.3},
    url = {https://CRAN.R-project.org/package=hawkesbow},
  }

Readme and manuals

hawkesbow

Felix Cheysson

This package implements a spectral approach to the parametric estimation of Hawkes processes from Binned Observations through Whittle likelihood (HawkesBOW). It is based on the results of the article (Cheysson and Lang 2020).

Installation

You can install the released version of hawkesbow from GitHub with:

devtools::install_github("fcheysson/hawkesbow")

The Hawkes process

Hawkes processes form a family of models for point processes for which the occurrence of an event temporarily increases the probability of future events occurring (Hawkes 1971). Formally, a Hawkes process $N$ on $\mathbb R$ can be defined from its conditional intensity $\lambda(\cdot)$ : where the variables $T_i$ denote the arrival times of the process, the immigration intensity $\eta$ is a positive constant, and the reproduction function $h: \mathbb R_{\ge 0} \rightarrow \mathbb R_{\ge 0}$ is a measurable function. The reproduction function can be further decomposed as $h = \mu h^\ast$ , where $\mu = \int_\mathbb R h(t) \mathrm{d} t < 1$ is called the and $h^\ast$ is a true density function, $\int_\mathbb{R} h^\ast(t) \mathrm{d} t = 1$ , called the .

Alternatively, the Hawkes process can be constructed as a poissonian cluster process (Hawkes and Oakes 1974). The process consists of a flow of immigrants, the cluster centres, arriving according to a homogeneous Poisson process of intensity $\eta$ . Then, an immigrant arriving at time $T_i$ generates children according to an inhomogeneous Poisson process of intensity $h(\cdot - T_i)$ . These in turn independently generate children according to the same process, and so on ad infinitum. The processes consisting of an immigrant and all its descendants are therefore branching processes, and are independent of each other. Finally, the process resulting from the superposition of all these branching processes is a Hawkes process of conditional intensity $\lambda(\cdot)$ (see the following figure of a realisation of an exponential Hawkes process with $\\eta = 1$ , $h(t) = e^{-2t}$ ).

Realisation of an exponential Hawkes process

This package also supports non-causal Hawkes processes, for which the reproduction kernel $h^\ast$ may take non-negative values on $\mathbb R_{\le 0}$ . Such processes are not defined through their conditional intensity functions, but through the poisson cluster representation, where each individual can potentially generate offsprings both in the future and in the past.

The count sequence of a Hawkes process is the time series generated by the event counts of the process, that is the series obtained by counting the events of the process on intervals of fixed length. Formally, the count sequence with bin size $\Delta$ associated to the point process $N$ is the sequence $(X_k)_{k \in \mathbb Z}$ .

Estimation procedure

This package fully supports the parametric estimation of Hawkes processes from their count sequences via minimisation of the Whittle likelihood, and partially supports the estimation from the arrival times via maximisation of the likelihood.

Maximum likelihood estimation

The parameters of a Hawkes process with arrival times $(T_i)_{1\le i\le n}$ on the interval $[0, T]$ can be estimated by maximising the following pseudo-likelihood
$\mathcal L_n(\theta) = \left( \prod_{i=1}^n \lambda(T_i) \right) \exp \left( - \int_0^T \lambda(s) \mathrm ds \right).$
Note that each step of the optimisation is usually of complexity $\mathcal O(n^2)$ .

Minimisation of the Whittle likelihood

Alternatively, the parameters of a Hawkes process with count sequence $(X_k)_{1\le k\le N}$ can be estimated by minimising the log-spectral (Whittle) likelihood
$\mathcal L_N^\prime(\theta) = \frac{1}{4\pi} \int_{-\pi}^\pi \left( \log f_\theta(\omega) + \frac{I_N(\omega)}{f_\theta(\omega)} \right) \mathrm d\omega,$
where $I_N(\omega) = (2\pi N)^{-1} \left| \sum_{k=1}^N X_k \exp(-ik\omega) \right|^2$ denotes the periodogram of $(X_k)$ and $f_\theta(\cdot)$ its spectral density function. Note that each step of the optimisation is of complexity $\mathcal O(n)$ and the periodogram can be calculated in complexity $\mathcal O(n \log n)$ using a Fast Fourier Transform algorithm, making this method usually faster than maximum likelihood estimation.

Main usage

This package supports both Hawkes processes and their count sequences.

Simulation of Hawkes processes

Hawkes processes can be simulated by the function hawkes:

hawkes(end, fun, repr, family, M=null, ...)

where end denotes the end of the interval $[0,T]$ . This function uses the cluster representation:

First, the immigrants are drawn according to a (potentially inhomogeneous) Poisson process with intensity measure fun.
Second, the number of offsprings of an immigrant are drawn from a Poisson distribution with intensity repr.
Third, these offsprings are distributed according to the family distribution.
Then, further offsprings are generated according to the last two steps.

The argument fun can take a numeric value or be specified as a function, in which case the argument M must be specified as an upper bound on fun (to allow simulation of the immigration process by thinning). The argument family can either be specified as a string name corresponding to a distribution with random generation function rname (for example exp for rexp), or directly as a random generation function. The optional arguments ... are passed to the random generation function specified by family.

This returns a list of class hawkes, whose realisations are stored in the member p. Other members of the list are mainly used for support functions.

Examples

Simulate a Hawkes process with immigration intensity $\eta = 1$ , reproduction mean $\mu = 0.5$ and reproduction kernel $h^\ast(t) = 2e^{-2t} 1_{\{t \ge 0\}}$ on $[0, 10]$ :

x <- hawkes(10, fun = 1, repr = 0.5, family = "exp", rate = 2)

Simulate a Hawkes process with inhomogeneous immigration process with intensity $\eta(t) = 1 + \sin(t)$ , reproduction mean $\mu = 0.25$ and $[0,1]$ -triangular reproduction kernel $h^\ast(t) = (1 - t)1_{\{0 \le t \le 1\}}$ :

x <- hawkes(10, fun=function(y) {1+sin(y)}, M=2, repr=0.25,
            family=function(n) {1 - sqrt(1 - runif(n))})

Plot function

Hawkes processes can be plotted with the function plot.hawkes:

plot.hawkes(x, intensity = FALSE, precision = 1e3, fun = NULL, repr = NULL, family = NULL, 
            M = NULL, ...)

If x is of class hawkes, as for objects returned by the function hawkes, arguments fun through M can be ignored. If intensity is set to FALSE, this plots the genealogy of the simulated Hawkes process (as in preceding figure, bottom panel). If it is set to TRUE, this plots the conditional intensity of the process (as in preceding figure, top panel).

Estimation of Hawkes processes

Two functions implement the estimation of Hawkes processes: mle from arrival times $(T_i)$ and whittle from count sequences $(X_k)$ . While the optimisation procedure rely on existing functions (see below), calculations of both the usual and Whittle likelihood functions are done in C++ via Rcpp (Eddelbuettel and François 2011) and RcppArmadillo (Eddelbuettel and Sanderson 2014).

By maximum likelihood

The maximum likelihood method is implemented by the function

mle(events, kern, end, init = NULL, opts = NULL, ...)

events holds the arrival times $(T_i)$ in ascending order, kern must be a string (partially) matching one of the reproduction kernels (see below) and end denotes the endpoint $T$ of observation of the process.

The optimisation of the maximum likelihood function is done by the function nloptr from the package nloptr (Johnson, n.d.) with algorithm L-BFGS-B, where the derivatives of the likelihood are calculated explicitly. By default, parameters are constrained to be positive, and additionally $\mu$ is constrained to be below 1. However, both the arguments opts and ... are passed on to nloptr, so the algorithm, the constraints, or any other parameter of the optimisation procedure can be changed.

Example of use:

x = hawkes(100, fun = 1, repr = .5, family = "exp", rate = 1)
mle(x$p, "Exponential", x$end)

By minimisation of the Whittle likelihood

The Whittle likelihood method is implemented by the function

whittle(counts, kern, binsize = NULL, trunc = 5L, init = NULL, ...)

counts holds the count sequence $(X_k)$ , kern must be a string (partially) matching one of the reproduction kernels (see below), binsize denotes the bin size $\Delta$ and trunc is the number of foldings due to aliasing taken into account.

The optimisation of the Whittle likelihood function is done by the function optim, with algorithm L-BFGS-B where the derivatives of the likelihood are approximated by finite differences. By default, parameters are constrained to be positive, and additionally $\mu$ is constrained to be below 1. However, the argument ... is passed to optim, so any optimisation parameter can be changed.

Example of use:

x = hawkes(1000, fun = 1, repr = .5, family = "exp", rate = 1)
y = discrete(x, binsize = 1)
whittle(y, "Exponential", 1)

Note that discrete is a useful function to create the count sequence $(X_k)$ associated with an object x of class hawkes.

Reproduction kernels

We introduce the reproduction kernels that are currently implemented in this package. Recall that the Fourier transform of a reproduction kernel is given by
$\widetilde {h^\ast}(\omega) = \int_\mathbb R \exp(-i\omega t) h(t) \mathrm dt,$
and that it is a Hermitian function $\widetilde {h^\ast}(-\omega) = \overline{\widetilde {h^\ast}(\omega)}$ .

The exponential kernel

This is the exponential density function with parameter $\beta > 0$ :
$h^\ast(t) = \beta e^{-\beta t} 1_{\{t > 0\}}.$
Its Fourier transform is
$\widetilde {h^\ast}(\omega) = \beta \frac{1}{\beta + i\omega} = \beta \frac{\beta - i \omega}{\beta^2 + \omega^2}.$

The exponential kernel can be specified with the string Exponential and the parameter $\beta$ with the usual argument rate. Both maximum and Whittle likelihood methods are fully implemented for exponential kernels. Moreover, the likelihood function is implemented in complexity $\mathcal O(n)$ , using the relations in (Ozaki and Ogata 1979).

The symmetric exponential kernel

This is a symmetrised version of the exponential density function with parameter $\beta > 0$ :
$h^\ast(t) = \frac 1 2 \beta e^{-\beta |t|}.$
Its Fourier transform is
$\widetilde {h^\ast}(\omega) = \frac{\beta^2}{\beta^2 + \omega^2}.$

The symmetric exponential kernel can be specified with the string SymmetricExponential and the parameter $\beta$ with the argument rate. Only the Whittle likelihood method is implemented for symmetric exponential kernels. Note that it is a non-causal kernel, as $h^\ast(t) \ne 0$ for $t < 0$ .

The gaussian kernel

This is the gaussian density function with mean $\nu \in \mathbb R$ and variance $\sigma^2 > 0$ :
$h^\ast(t) = \frac{1}{\sigma \sqrt{2\pi}}\exp\left(-\frac{(t-\nu)^2}{2\sigma^2}\right).$
Its Fourier transform is
$\widetilde {h^\ast}(\omega) = \exp\left(-\frac{\sigma^2\omega^2}{2}-i\nu\omega\right).$

The gaussian kernel can be specified with the string Gaussian and its parameters $\nu$ and $\sigma$ with the usual arguments mean and sd respectively. Only the Whittle likelihood method is implemented for gaussian kernels. Note that it is a non-causal kernel, as $h^\ast(t) \ne 0$ for $t < 0$ .

The power law kernel

This is a normalised and shifted power law function, with shape $\theta > 0$ and scale $a > 0$ :
$h^\ast(t) = \theta a^\theta (t+a)^{-\theta-1} 1_{\{\theta > 0 \}}.$
For positive $\omega$ , its Fourier transform is given by
$\widetilde{h_\theta^\ast}(\omega) = \theta \exp(i\omega a)E_{\theta + 1} (i\omega a),$
where $E_{\theta}(ix)$ denotes the integral
$E_{\theta}(ix) = \int_1^\infty t^{-\theta} \exp(-ixt) \mathrm dt.$
With successive integration by parts, this integral can be related to $E_{\theta'}(ix)$ , with $0 < \theta' \le 1$ .

If $\theta' = 1$ or equivalently $\theta \in \mathbb N_{\ne 0}$ , the integral $E_1(ix)$ , called the exponential integral with imaginary argument, can be related the trigonometric integrals and calculated using Padé approximants (Rowe et al. 2015, Appendix B), accurate to better than $10^{-16}$ . The function E1_imaginary implements this approximation.

If $\theta' < 1$ or equivalently $\theta \in \mathbb R \setminus \mathbb N$ , the integral $E_\theta(ix)$ can be related to the incomplete gamma function with imaginary argument
$\Gamma_i(x, \alpha) = \int_x^\infty t^{\alpha-1} e^{-it} \mathrm{d}t,$
where $0 < \alpha < 1$ . We implemented Taylor approximations of this integral, accurate to better than $10^{-7}$ , in the function inc_gamma_imag.

The power law kernel can be specified with the string PowerLaw and its parameters $\theta$ and $a$ with the arguments shape and scale respectively. Both maximum and Whittle likelihood methods are implemented for power law kernels.

The Pareto kernels

This is the Pareto density function with shape $\theta > 0$ and scale $a > 0$ :
$h_\theta^\ast(t) = \theta a^\theta t^{-\theta - 1} 1_{\{t > a\}}.$
For positive $\omega$ , its Fourier transform is given by
$\widetilde{h_\theta^\ast}(\omega) = \theta E_{\theta + 1} (i\omega a),$
see above for the definition of $E_\theta(ix)$ .

Only Pareto kernels with fixed $\theta = 1$ , $2$ , and $3$ have been implemented and can specified with the strings Pareto1, Pareto2 and Pareto3 respectively, with parameter $a$ specified with the argument scale. Only the Whittle method is available for Pareto kernels.

To be implemented

Improve this vignette: it is currently too sparse and functions of the package could need some better description.
Add some real datasets to the package: real life case-studies with good datasets help understand the functionalities of a package.
Variance and confidence intervals for the estimation with function whittle: note that currently, the variance-covariance matrix returned by the optimisation method in function whittle is not accurate, as it ignores the dependence within the count sequence $(X_k)$ .
Diagnostics for the estimated model: spectral density based goodness-of-fit tests are to be implemented for the estimated Hawkes processes, based on the work of (Paparoditis 2000).
Custom built-kernels: allow the user to input reproduction kernels that are not already implemented.

References

Cheysson, Felix, and Gabriel Lang. 2020. “Strong mixing condition for Hawkes processes and application to Whittle estimation from count data.” arXiv, March. https://arxiv.org/abs/2003.04314.

Eddelbuettel, Dirk, and Romain François. 2011. “Rcpp : Seamless R and C++ Integration.” J. Stat. Softw. 40 (8): 1–18. https://doi.org/10.18637/jss.v040.i08.

Eddelbuettel, Dirk, and Conrad Sanderson. 2014. “RcppArmadillo: Accelerating R with High-Performance C++ Linear Algebra.” Computational Statistics and Data Analysis 71: 1054–63. http://dx.doi.org/10.1016/j.csda.2013.02.005.

Hawkes, Alan G. 1971. “Spectra of Some Self-Exciting and Mutually Exciting Point Processes.” Biometrika 58 (1): 83–90. https://doi.org/10.2307/2334319.

Hawkes, Alan G., and David Oakes. 1974. “A cluster process representation of a self-exciting process.” J. Appl. Probab. 11 (03): 493–503. https://doi.org/10.2307/3212693.

Johnson, Steven G. n.d. “The NLopt nonlinear-optimization package.”

Ozaki, T., and Yosihiko Ogata. 1979. “Maximum likelihood estimation of Hawkes’ self-exciting point processes.” Ann. Inst. Stat. Math. 31 (1): 145–55. https://doi.org/10.1007/BF02480272.

Paparoditis, Efstathios. 2000. “Spectral density based goodness-of-fit tests for time series models.” Scand. J. Stat. 27 (1): 143–76. https://doi.org/10.1111/1467-9469.00184.

Rowe, B. T. P., M. Jarvis, R. Mandelbaum, G. M. Bernstein, J. Bosch, M. Simet, J. E. Meyers, et al. 2015. “GalSim: The modular galaxy image simulation toolkit.” Astron. Comput. 10: 121–50. https://doi.org/10.1016/j.ascom.2015.02.002.

Help Manual

Help page	Topics
Compensator of a Hawkes process	compensator
Discretizes a Hawkes simulation	discrete
The power law distribution	dpowerlaw ppowerlaw qpowerlaw rpowerlaw
Exponential integral of imaginary argument	E1_imaginary
Incomplete gamma function of imaginary argument with arbitrary power	Etheta_imaginary
Reproduction kernels for the Hawkes processes	Exponential Gaussian Pareto1 Pareto2 Pareto3 PowerLaw SymmetricExponential
Simulation of a Hawkes process	hawkes
Simulation of a Hawkes process	hawkes_ogata
Incomplete gamma function of imaginary argument	inc_gamma_imag
Simulation of an inhomogeneous Poisson process by thinning	inhpois
Intensity of a Hawkes process	intensity
Fitting Hawkes processes from continuous data	mle
C++ abstract class for Hawkes processes	Model
Plot of a Hawkes process	plot.hawkes
Plot of a simulated Hawkes process	plot.hawkes_ogata
Plot of a simulated inhomogeneous Poisson process	plot.inhpois
Residuals of a Hawkes process	residuals
Fitting Hawkes processes from discrete data	whittle

Package: hawkesbow 1.0.3

hawkesbow: Estimation of Hawkes Processes from Binned Observations

hawkesbow

Citation

Readme and manuals

hawkesbow

Installation

The Hawkes process

Estimation procedure

Maximum likelihood estimation

Minimisation of the Whittle likelihood

Main usage

Simulation of Hawkes processes

Examples

Plot function

Estimation of Hawkes processes

By maximum likelihood

By minimisation of the Whittle likelihood

Reproduction kernels

The exponential kernel

The symmetric exponential kernel

The gaussian kernel

The power law kernel

The Pareto kernels

To be implemented

References

Help Manual

Usage by other packages (reverse dependencies)