Back to Adaptive Vision Library website

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

ImageMaximum


Header: AVL.h
Namespace: avl
Module: FoundationLite

Finds the location and the value of the brightest pixel.

Syntax

C++
C#
 
void avl::ImageMaximum
(
	const avl::Image& inImage,
	atl::Optional<const avl::Region&> inRoi,
	atl::Optional<avl::Location&> outMaximumLocation,
	atl::Optional<float&> outMaximumValue = atl::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 atl::NIL to these parameters: outMaximumLocation, outMaximumValue.

Read more about Optional Outputs.

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.