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

ImageMaximum

Header:	FIL.h
Namespace:	fil
Module:	FoundationLite

Finds the location and the value of the brightest pixel.

Syntax

void fil::ImageMaximum
(
	const fil::Image& inImage,
	ftl::Optional<const fil::Region&> inRoi,
	ftl::Optional<fil::Location&> outMaximumLocation,
	ftl::Optional<float&> outMaximumValue = ftl::NIL
)

Parameters

Name	Type	Default	Description
inImage	const Image&		Input image
inRoi	Optional<const Region&>	NIL	Range of pixels to be processed
outMaximumLocation	Optional<Location&>
outMaximumValue	Optional<float&>	NIL

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::NIL to these parameters: outMaximumLocation, outMaximumValue.

Examples

ImageMaximum used to detect the brightest point.

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.

Errors

List of possible exceptions:

Error type	Description
DomainError	Empty region on input in ImageMaximum.
DomainError	Region exceeds an input image in ImageMaximum.