Back to FabImage Library website

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

ImageMinimum


Header: FIL.h
Namespace: fil
Module: FoundationLite

Finds the location and the value of the darkest pixel.

Syntax

C++
C#
 
void fil::ImageMinimum
(
	const fil::Image& inImage,
	ftl::Optional<const fil::Region&> inRoi,
	ftl::Optional<fil::Location&> outMinimumLocation,
	ftl::Optional<float&> outMinimumValue = 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&>
Output value outMinimumValue Optional<float&> NIL

Optional Outputs

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

Read more about Optional Outputs.

Examples

ImageMinimum used to detect the darkest 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 ImageMinimum.
DomainError Region exceeds an input image in ImageMinimum.