You are here: Start » Function Reference » Image Pixel Statistics » ImageStatistics

ImageStatistics

Header:	FIL.h
Namespace:	fil

Computes various statistics of the image pixel values.

Syntax

void fil::ImageStatistics
(
	const fil::Image& inImage,
	ftl::Optional<const fil::Region&> inRoi,
	ftl::Optional<fil::Location&> outMinimumLocation,
	ftl::Optional<float&> outMinimumValue,
	ftl::Optional<fil::Location&> outMaximumLocation,
	ftl::Optional<float&> outMaximumValue,
	ftl::Optional<fil::Pixel&> outAverageColor,
	ftl::Optional<float&> outAverageValue,
	ftl::Optional<fil::Pixel&> outSumColor,
	ftl::Optional<float&> outSumValue
)

Parameters

Name	Type	Default	Description
inImage	const Image&		Input image
inRoi	Optional<const Region&>	NIL	Range of pixels to be processed
outMinimumLocation	Optional<Location&>
outMinimumValue	Optional<float&>
outMaximumLocation	Optional<Location&>
outMaximumValue	Optional<float&>
outAverageColor	Optional<Pixel&>
outAverageValue	Optional<float&>
outSumColor	Optional<Pixel&>
outSumValue	Optional<float&>

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::NIL to these parameters: outMinimumLocation, outMinimumValue, outMaximumLocation, outMaximumValue, outAverageColor, outAverageValue, outSumColor, outSumValue.

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.