Back to FabImage Library website

You are here: Start » Function Reference » Histogram » Histogram Data Statistics » HistogramDataNthValue

HistogramDataNthValue


Header: FIL.h
Namespace: fil
Module: FoundationBasic

Computes nth smallest (or largest) value of the histogrammed numeric data.

Syntax

C++
C#
 
void fil::HistogramDataNthValue
(
	const fil::Histogram& inHistogram,
	const double inN,
	const fil::SortingOrder::Type inSortingOrder,
	float& outNthValue
)

Parameters

Name Type Default Description
Input value
 inHistogram const Histogram& Input histogram
Input value
 inN const double
Input value
 inSortingOrder const SortingOrder::Type
Output value
 outNthValue float& Nth smallest (or largest) value of the histogrammed data

Errors

List of possible exceptions:

Error type Description
DomainError Input histogram contains negative bins in HistogramDataNthValue.
DomainError Selected N exceeds index range in HistogramDataNthValue.