Histogram
The Histogram operator receives a numeric value as input and increments the counter of the bin that corresponds to the range in which the value lies. The array of counts is then sent in the output port.
Configuration Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
nBins |
int |
The number of bins of the histogram. It must be greater than zero. Default: 10 |
|
rangeMin |
float64 |
The minimum value on the x axis. Input values lower than *rangeMin* are ignored. Default: 0.0 |
|
rangeMax |
float64 |
The maximum value on the x axis. Input values higher than *rangeMax* are ignored. Default: 1.0 |
|
outputEveryNInput |
uint64 |
Sends an accumulated histogram on every *outputEveryNInput* values received in the input port. It is only sent if the histogram has changed since the last send (it may not have changed if the values received were out of range). Default: 1 |
|
outputPeriodInSec |
float64 |
Sends an accumulated histogram every *outputPeriodInSec* seconds. It is only sent if the histogram has changed since the last send (it may not have changed if the values received were out of range). Default: 0.0 |
Input
|
Input |
Type |
Description |
|---|---|---|
|
histIn |
any |
A numeric value that is converted to float64. It can be a string or blob that represents a numeric value or a golang primitive numeric type. |
Output
|
Output |
Type |
Description |
|---|---|---|
|
histOut |
message |
A Data Pipeline message with the histogram in the body as a array of uint64, and the message header has the rangeMin and rangeMax from the configuration. |