Back to Aurora Vision Studio website

You are here: Start » Filter Reference » Histogram » Histogram Basics » MakeHistogram

MakeHistogram


Module: FoundationBasic

Creates a histogram out of an array of bin values.

Name Type Range Description
Input value inValues DoubleArray Input array of bin values
Input value inDomainStart Real Input domain begin
Input value inBinSize Real 0.0 - Input length of the domain range covered by a single bin
Input value inStartIndex Integer 0 - + Index of the first bin in the values array
Input value inBinCount Integer* 1 - + Number of bins in the resulting histogram
Output value outHistogram Histogram Output histogram

Remarks

The calculated bin count must be equal to element count of the inValues array.

Errors

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type Description
DomainError Empty inValues array on input in MakeHistogram.
DomainError Input inStartIndex out of bound in MakeHistogram.
DomainError Non-positive value of inBinSize in MakeHistogram.
DomainError Not enough data to fill all bins or inBinCount too large in MakeHistogram.

Complexity Level

This filter is available on Advanced Complexity Level.

See Also