Collect1D (Node)
Accumulate a 1D histogram
| Context | Analysis |
| Name Required? | Yes |
| Branches | SubCollect |
Overview
The Collect1D node is used to accumulate a histogram of a one-dimensional quantity, extracted from a Calculate-style nodes.
Description
Where the Calculate* nodes are responsible for calculating quantities, the Collect* nodes are responsible for accumulating averages, typically in histogram format.
Collect1D accumulates a histogram of a target value taken from a Calculate* node, over a specified range and binwidth. No post-processing (e.g. normalisation) is performed by Collect1D - see the
Process1D
for processing options.
Branching
The Collect* nodes all have a branch (accessed through the hidden SubCollect keyword) which is executed if the value is successfully binned (i.e. is within all ranges specified).
Options
Quantities / Ranges
| Keyword | Arguments | Default | Description |
|---|---|---|---|
QuantityX |
name[index] |
– | Required The calculated observable to collect. The named node must be one of theCalculate* nodes. The index specifies which value to take from multi-dimensional observables, starting from zero for the first. If not specified, index` defaults to zero. |
RangeX |
minmaxdelta |
– | Defines the range and binwidth of the histogram over which QuantityX will be accumulated. |