GitHub

Quick Start

This section describes the most important surface level API: creating histogram.

There are two possible ways to make a histogram:

  • make an empty histogram to be filled later (via atomic_push!)
  • make a filled histogram given data

We call the first one "constructor like" use case and the second one "fit like" use case (as in "fit data to a histogram").

Each of the two options imply a set of options that can go with them. The two sets of options have some overlap, e.g. binedges, overflow; but there are also options only make sense of one of them, e.g., nbins only works in the "fit like" use case.

Make an empty histogram

The minimal information needed is binedges:

h1 = Hist1D(; binedges = 1:10)
1.0 10.0
  • edges: [1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0]
  • bin counts: [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]
  • maximum count: 0.0
  • total count: 0.0

You can provide more if you have them available (for example, when you're creating histogram from another data source):

h2 = Hist1D(; binedges = 1:10, bincounts = collect(1:9))
1.0 10.0
  • edges: [1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0]
  • bin counts: [1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0]
  • maximum count: 9.0
  • total count: 45.0
Default / infer strategy for empty histogram

To see the full list of keyword arguments as well as how they are inferred, see Hist1D. To summarize in words:

  1. counttype defaults to Float64 because maxintfloat(Float64) ≈ 9e15
  2. binedges must be provided by user
  3. bincounts defaults to all zero, with eltype == counttype and appropriate shape
  4. sumw2 defaults to all zero with appropriate shape
  5. nentries defaults to 0
  6. overflow defaults to false

Make a filled histogram given data

The minimal information needed is data, which is a positional argument:

h3 = Hist1D(randn(2000))
-4.0 4.0
  • edges: [-4.0, -3.0, -2.0, -1.0, 0.0, 1.0, 2.0, 3.0, 4.0]
  • bin counts: [5.0, 52.0, 261.0, 652.0, 692.0, 294.0, 42.0, 2.0]
  • maximum count: 692.0
  • total count: 2000.0

You can provide more (in keyword arguments) if you want granular control over the binning behavior (e.g. number of bins, the exact bins to use):

h4 = Hist1D(randn(2000); nbins=4)
-4.0 6.0
  • edges: [-4.0, -2.0, 0.0, 2.0, 4.0, 6.0]
  • bin counts: [47.0, 938.0, 973.0, 41.0, 1.0]
  • maximum count: 973.0
  • total count: 2000.0
Warning

nbins is not strictly enforced, use binedges if you need exact control.

We can do non-uniform binning for example:

h5 = Hist1D(randn(2000); binedges = [0, 0.5, 0.8, 0.9, 1.0])
0.0 1.0
  • edges: [0.0, 0.5, 0.8, 0.9, 1.0]
  • bin counts: [396.0, 180.0, 53.0, 42.0]
  • maximum count: 396.0
  • total count: 671.0
Default / infer strategy for filled histogram with data

To see the full list of keyword arguments as well as how they are inferred, see Hist1D. To summarize in words:

  1. data array must be provided by the user
  2. counttype defaults to Float64 because maxintfloat(Float64) ≈ 9e15
  3. nbins defaults to sturges approximation
  4. binedges defaults to uniform binning given nbins
  5. weights defaults to all unity (i.e. not weighted)
  6. overflow defaults false