experimental.histogram() function

experimental.histogram() approximates the cumulative distribution of a dataset by counting data frequencies for a list of bins.

A bin is defined by an upper bound where all data points that are less than or equal to the bound are counted in the bin. Bin counts are cumulative.

Function behavior

• Outputs a single table for each input table.
• Each output table represents a unique histogram.
• Output tables have the same group key as the corresponding input table.
• Drops columns that are not part of the group key.
• Adds an le column to store upper bound values.
• Stores bin counts in the _value column.

Function type signature

(<-tables: stream[{A with _value: float}], bins: [float], ?normalize: bool) => stream[{A with le: float, _value: float}]

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

bins

({{< req >}}) List of upper bounds to use when computing histogram frequencies, including the maximum value of the data set.

This value can be set to positive infinity (float(v: "+Inf")) if no maximum is known.

Bin helper functions

The following helper functions can be used to generated bins.

• linearBins()
• logarithmicBins()

normalize

Convert count values into frequency values between 0 and 1. Default is false.

Note: Normalized histograms cannot be aggregated by summing their counts.

tables

Input data. Default is piped-forward data (<-).

Examples

Create a histogram from input data

import "experimental"
import "sampledata"

sampledata.float()
    |> experimental.histogram(
        bins: [
            0.0,
            5.0,
            10.0,
            15.0,
            20.0,
        ],
    )

{{< expand-wrapper >}} {{% expand "View example input and output" %}}

Input data

Output data

{{% /expand %}} {{< /expand-wrapper >}}