Back to Aurora Vision Library website
You are here: Start » Function Reference » Histogram » Histogram Basics » GetHistogramBin
GetHistogramBin
Header: | AVL.h |
---|---|
Namespace: | avl |
Module: | FoundationBasic |
Returns the value of a single histogram bin.
Syntax
C++
C#
void avl::GetHistogramBin ( const avl::Histogram& inHistogram, int inIndex, const bool inCyclic, const bool inInverse, double& outValue, atl::Optional<float&> outBinStart = atl::NIL, atl::Optional<float&> outBinEnd = atl::NIL )
Parameters
Name | Type | Default | Description | |
---|---|---|---|---|
inHistogram | const Histogram& | Input histogram | ||
inIndex | int | Input bin index | ||
inCyclic | const bool | False | Whether to wrap the index around or not | |
inInverse | const bool | Reversed order of bins | ||
outValue | double& | Output value of the bin | ||
outBinStart | Optional<float&> | NIL | Lower limit of the bin | |
outBinEnd | Optional<float&> | NIL | Upper limit of the bin |
Optional Outputs
The computation of following outputs can be switched off by passing value atl::NIL
to these parameters: outBinStart, outBinEnd.
Read more about Optional Outputs.
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Incorrect index on input in GetHistogramBin. |