You are here: Start » Function Reference » Histogram Basics » GetHistogramBin

GetHistogramBin

Header:	FIL.h
Namespace:	fil

Returns the value of a single histogram bin.

Syntax

void fil::GetHistogramBin
(
	const fil::Histogram& inHistogram,
	int inIndex,
	const bool inInverse,
	int& outValue,
	ftl::Optional<float&> outBinStart = ftl::NIL,
	ftl::Optional<float&> outBinEnd = ftl::NIL
)

Parameters

Name	Type	Range	Default	Description
inHistogram	const Histogram&			Input histogram
inIndex	int	0 - +		Input bin index
inInverse	const bool			Reversed order of bins
outValue	int&			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 ftl::NIL to these parameters: outBinStart, outBinEnd.

Errors

List of possible exceptions:

Error type	Description
DomainError	Incorrect index on input in GetHistogramBin.