Description
Group original observation indexes into explicit histogram bins and retain outside-domain indexes.
Histogram edges divide a numeric coordinate axis into ordered bins, while each bin mass represents a count or nonnegative weight. Probability mass is a fraction of the total; probability density additionally divides by bin width and therefore has inverse coordinate units. An edge plan alone contains no observations.
Group original observation indexes into explicit histogram bins and retain outside-domain indexes.
When to use this tool
Use provenance groups to trace each binned or out-of-domain observation back to its original position.
How to use the tool and how it works
- Enter values, edges using the definitions below.
- Run the operation. Resolve input-format errors before interpreting an output.
- Read result.bins, result.outside, using the stated boundary, ordering, sign and absence conventions.
For each observation in original order, find its interval among the increasing edges and append the original observation index to that bin. Record indexes outside the full edge domain separately.1
| Input field | Meaning and units | Accepted input |
|---|---|---|
| values | Finite observations in original input order, on the edge coordinate scale. | Dense list of at most 128 finite numbers, under the stated integer/range rules. |
| edges | At least two finite strictly increasing coordinate edges. Their units define interval lengths and density units. | Dense list of at most 128 finite numbers, under the stated integer/range rules. |
| Output field | Interpretation |
|---|---|
| result | Object containing the fields below. |
| result.bins | One list per bin containing original observation indexes, in observation order. |
| result.outside | Original indexes of observations outside the inclusive outer edge domain. |
{
"input": {
"values": [
-1,
0,
1,
2,
3
],
"edges": [
0,
1,
2
]
},
"output": {
"result": {
"bins": [
[
1
],
[
2,
3
]
],
"outside": [
0,
4
]
}
}
}Limitations and assumptions
- Bins include their left edge and exclude their right edge, except that the final edge belongs to the last bin. Duplicate values retain separate original indexes.
- Edge lists contain at least two finite strictly increasing numbers. A mass array paired with edges has exactly one nonnegative finite mass per interval. Other mass-only operations accept empty arrays. Floating-point calculations do not imply exact decimal arithmetic or recover observations inside a bin.
- Every declared outer field is required and unknown outer fields are rejected. Strings and JSON text have size limits, lists are bounded to 128 entries, and JSON nesting/node counts are bounded. Tighter operation-specific bounds stated above take precedence.
- Numeric outputs must remain finite and within safe-integer magnitude. Original record indexes and cell coordinates are zero-based; stated half-open ranges exclude their end.
Alternative or Complementary methods
Keep edge definitions with mass arrays. Use common-boundary coarsening and whole-bin merging for aligned comparisons; use observation-level data when a calculation requires locations within bins.
References
Similar or alternative tools
- Histogram Bin Probability Table
Convert supplied bin masses into fractions of total mass, returning nulls for zero total.
- Histogram Domain Coverage Budget
Divide a supplied coordinate interval into lengths inside, below and above the histogram domain.