## BayesHistogram.jl

Pure Julia package for optimal histogram binning, based on piecewise constant model.
Popularity
40 Stars
Updated Last
8 Months Ago
Started In
October 2022

# BayesHistogram.jl

Optimal histogram binning based on piecewise constant model.

Paper: Studies in Astronomical Time Series Analysis. VI. Bayesian Block Representations [https://arxiv.org/abs/1207.5578]

## Introduction

Have you ever hated the default histogram binning rules in your favourite analysis and plotting library?

You can solve your problem by relying on `BayesHistogram.jl`! :)

This package provides the function `bayesian_blocks`, which determines the bin sequence that maximises the probability of observing your data, assuming a histogram can describe it.

In other words, the package implements a complicated algorithm that returns the optimal histogram, respecting some simple constraints you can customise.

If you can't take it anymore, go directly to the usage examples or look at the file `make_plot.jl`, or if you want to know all the internal details look at `test/run_tests.jl`.

Four ingredients determine the optimal histogram:

1. The likelihood of a given bin.
2. The apriori probability of observing that bin.
3. The maximum resolution at which you want to separate the data (default is `Inf`).
4. The minimum possible number of observations in each bin (default is `1`).

How can you influence these factors?

1. It is not modifiable. For a long time now, the Likelihood principle and its natural Bayesian extension have been part of the toolbox of every statistician: it is a solid principle that we can reasonably trust :)

2. It is modifiable. The package implements a wide choice of possibilities. Indeed you can choose the prior among the following alternatives:

• `BIC` (default): Bayesian information criterion, requires no parameters and is asymptotically consistent.
• `AIC`: Akaike information criterion: minimises prediction error, requires no parameters (in some cases adds too many bins, but the problem can be solved using (3) and (4)).
• `HQIC`: Hannan-Quinn criterion, has intermediate behaviour between BIC and AIC, is close to consistency, and tries to minimise prediction error.
• `FPR(p)`: Scargle Criterion, a data bin is added if it has a false positive rate lower than `p`.
• `Geometric(gamma)`: varying the parameter `gamma` changes the average number of bins allowed.
• `Pearson(p)`: This is useful when you want bins containing about `N*p` observations, where `N` is the total number of events.
• `NoPrior`: for non-Bayesians, it always requires tuning (3) and (4).
• `?`, You can implement a customised prior by following the examples in the `src/priors.jl` file
3. If you need to alter this parameter, add the keyword argument `resolution = ?` to the `bayesian_blocks` function. A typical value might be `100`.

4. Like (3), you can configure it via `min_counts = ?`.

Thank you for reading this (brief?) introductory section.

## Installation

```using Pkg

## Usage examples

for looking at every option available type in the repl `?bayesian_blocks`.

Examples:

```using Plots, BayesHistogram
X = exp.(randn(5000)./3)
bl = bayesian_blocks(X)
# plot using "to_pdf"
support, density = to_pdf(bl)
plot(support, density)
# or using "edges" parameter and an histogramming procedure
histogram(X, bins=bl.edges, normalize = :pdf)```

we can change the prior as follows:

```bl = bayesian_blocks(X, prior=AIC(), resolution=40)
plot(to_pdf(bl)...)
bl = bayesian_blocks(X, prior=FPR(0.2), resolution=40)
plot!(to_pdf(bl)...)```

we can also plot the errors:

```plot(to_pdf(bl)..., color="black")
scatter!(bl.centers, bl.heights, yerr = bl.error_heights, color="black")```

we can also estimate averages and their errors:

```estimate(bl) do v; v end
# result: (1.0610279949641472, 0.014646660658986687)

# the result can be refined by increasing the number of integration points

estimate(bl,100) do v; v^2 end
# result: (1.2574274634942957, 0.021142852215391358)```

## Showcase

### bins are determined automatically & optimally ### it handles weighted data and errors correctly ### it routinely outperforms common binning rules ### Required Packages

No packages found.