Back to Aurora Vision Library website
You are here: Start » Function Reference » Histogram » Histogram Basics » GetHistogramCorrespondingBin
GetHistogramCorrespondingBin
Header: | AVL.h |
---|---|
Namespace: | avl |
Module: | FoundationBasic |
Selects a bin that the given value in the histogram domain falls into and returns the value of this bin.
Syntax
C++
C#
void avl::GetHistogramCorrespondingBin ( const avl::Histogram& inHistogram, float inBinSelectionValue, const bool inCyclic, double& outValue )
Parameters
Name | Type | Default | Description | |
---|---|---|---|---|
inHistogram | const Histogram& | Input histogram | ||
inBinSelectionValue | float | Input value in the histogram domain that will be used to select the bin | ||
inCyclic | const bool | False | Whether to wrap the index around or not | |
outValue | double& | Output value of the bin |
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | inBinSelectionValue exceeds the histogram domain in GetHistogramCorrespondingBin. |