You are here: Start » FIL.NET » FIL.ImageHistogram

FIL.ImageHistogram

Computes the histogram of the image pixel values.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

C++
C#
 
public static void ImageHistogram
(
	FilNet.Image inImage,
	NullableRef<FilNet.Region> inRoi,
	int inChannelIndex,
	float inBinSize,
	float inDomainBegin,
	float inDomainEnd,
	FilNet.Histogram outHistogram
)

Parameters

Name Type Range Default Description
inImageFilNet.ImageInput image.
inRoiFilNet.NullableRef<FilNet.Region>Range of pixels to be processed. Default value: ftl::NIL.
inChannelIndexint<0, 3>Selects a channel of the input image.
inBinSizefloat<0.0f, INF>1.0fWidth of a single histogram bin. Default value: 1.0f.
inDomainBeginfloat0.0fThe lowest value that will be considered in the output histogram. Default value: 0.0f.
inDomainEndfloat256.0fThe upper-bound for values that will be considered in the output histogram. Default value: 256.0f.
outHistogramFilNet.HistogramOutput 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:

Error type Description
DomainError Region exceeds an input image in ImageHistogram.
DomainError Selected bin size equals zero in ImageHistogram.
DomainError Selected channel index is out of range in ImageHistogram.
DomainError Selected domain has zero or negative size ImageHistogram.

Function Overrides

See also