Back to Aurora Vision Library website

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

SetHistogramCorrespondingBin


Header: AVL.h
Namespace: avl
Module: FoundationBasic

Selects a bin that the given value in the histogram domain falls into and sets the value of this bin.

Syntax

C++
C#
 
void avl::SetHistogramCorrespondingBin
(
	avl::Histogram& ioHistogram,
	float inBinSelectionValue,
	const bool inCyclic,
	double inNewValue
)

Parameters

Name Type Default Description
Input will be modified ioHistogram 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
Input value inNewValue double Input new value to be set

Errors

List of possible exceptions:

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