Back to FabImage Library website

You are here: Start » Function Reference » Histogram » Histogram Features » HistogramMaximum

HistogramMaximum


Header: FIL.h
Namespace: fil
Module: FoundationBasic

Computes histogram bar values maximum - its location and value.

Syntax

C++
C#
 
void fil::HistogramMaximum
(
	const fil::Histogram& inHistogram,
	ftl::Optional<const fil::Range&> inRange,
	fil::HistogramInterpolationMethod::Type inInterpolationMethod,
	int& outMaximumLocation,
	float& outPoint,
	double& outMaximumValue
)

Parameters

Name Type Default Description
Input value inHistogram const Histogram& Input histogram
Input value inRange Optional<const Range&> NIL Search range
Input value inInterpolationMethod HistogramInterpolationMethod::Type Histogram bins interpolation method
Output value outMaximumLocation int& Output maximum location
Output value outPoint float& Output subpixel maximum location
Output value outMaximumValue double& Output maximum value

Errors

List of possible exceptions:

Error type Description
DomainError Empty histogram on input in HistogramMaximum.
DomainError Unsupported interpolation method in HistogramMaximum.

See Also

  • HistogramMinimum – Computes histogram bar values minimum - its location and value.