Start » Filter Reference » Histogram » Histogram Basics » GetHistogramBin

GetHistogramBin


Module: FoundationBasic

Returns the value of a single histogram bin.

Name Type Description
Input value
inHistogram Histogram Input histogram
Input value
inIndex Integer Input bin index
Input value
inCyclic Bool Whether to wrap the index around or not
Input value
inInverse Bool Reversed order of bins
Output value
outValue Double Output value of the bin
Output value
outBinStart Real Lower limit of the bin
Output value
outBinEnd Real Upper limit of the bin

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 Incorrect index on input in GetHistogramBin.

Complexity Level

This filter is available on Advanced Complexity Level.