You are here: Start » Function Reference » Image » Image Features » ImageHistogram

ImageHistogram

Header:	FIL.h
Namespace:	fil
Module:	FoundationBasic

Computes the histogram of the image pixel values.

Syntax

void fil::ImageHistogram
(
	const fil::Image& inImage,
	ftl::Optional<const fil::Region&> inRoi,
	int inChannelIndex,
	float inDomainBegin,
	const float inBinSize,
	int inBinCount,
	fil::Histogram& outHistogram
)

Parameters

Name	Type	Range	Default	Description
inImage	const Image&			Input image
inRoi	Optional<const Region&>		NIL	Range of pixels to be processed
inChannelIndex	int	0 - 3		Selects a channel of the input image
inDomainBegin	float		0.0f	The lowest value that will be considered in the output histogram
inBinSize	const float	0.0 -	1.0f	Width of a single histogram bin
inBinCount	int		256	The upper-bound for values that will be considered in the output histogram
outHistogram	Histogram&			Output histogram

Description

Histogram in FabImage Studio is a graphical representation of data contained in image. That is, the resulting histogram contains number of pixel values from specified channel with selected inBinSize (interval).

Examples

ImageHistogram performed on the Lena image with inChannelIndex = 0, inBinSize = 1.

Errors

List of possible exceptions: