Back to FabImage Library website

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

ImageStatistics


Header: FIL.h
Namespace: fil
Module: FoundationLite

Computes various statistics of the image pixel values.

Syntax

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

Parameters

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

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.

Read more about Optional Outputs.

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.

Errors

List of possible exceptions:

Error type Description
DomainError Region exceeds an input image in ImageStatistics.