Back to FabImage Library website

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

GetHistogramCorrespondingBin


Header: FIL.h
Namespace: fil
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 fil::GetHistogramCorrespondingBin
(
	const fil::Histogram& inHistogram,
	float inBinSelectionValue,
	const bool inCyclic,
	double& outValue
)

Parameters

Name Type Default Description
Input value inHistogram const Histogram& Input histogram
Input value inBinSelectionValue float Input value in the histogram domain that will be used to select the bin
Input value inCyclic const bool False Whether to wrap the index around or not
Output value outValue double& Output value of the bin

Errors

List of possible exceptions:

Error type Description
DomainError inBinSelectionValue exceeds the histogram domain in GetHistogramCorrespondingBin.