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

MakeHistogram

Creates a histogram assuming given bin values.

Syntax

void avl::MakeHistogram
(
	const atl::Array<int>& inValues,
	atl::real inDomainStart,
	atl::real inDomainLength,
	atl::real inBinSize,
	avl::Histogram& outHistogram
)

void MakeHistogram
(
	int[] inValues,
	float inDomainStart,
	float inDomainLength,
	float inBinSize,
	out AvlNet.Histogram outHistogram
)

Parameters

Name	Type	Range	Default	Description
inValues	const Array<int>&			Input array of bin values
inDomainStart	real		0.0f	Input domain begin
inDomainLength	real	0.0 -	256.0f	Input domain length
inBinSize	real	0.0 -	1.0f	Input length of the domain range covered by a single bin
outHistogram	Histogram&			Output histogram

Remarks

The calculated bin count must be equal to element count of the inValues array.

Errors

Error type	Description
DomainError	Empty inValues array on input in MakeHistogram.
DomainError	Non-positive value of inBinSize in MakeHistogram.
DomainError	The calculated bins count is greater than input values count in inValues.
DomainError	The calculated bins count is less than input values count in inValues.