Back to FabImage Library website

You are here: Start » Function Reference » All Functions » Array Statistics » GetMedianElement

GetMedianElement


This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Header: STD.h
Namespace: fil
Module: FoundationLite

Gets an array element corresponding to the median value from the inValues array.

Syntax

void fil::GetMedianElement
(
	const ftl::Array<Type>& inArray,
	const ftl::Array<float>& inValues,
	Type& outElement,
	float& outValue,
	int& outIndex
)

Parameters

Name Type Default Description
Input value inArray const Array<Type>& Elements from which element corresponding to median value will be chosen
Input value inValues const Array<float>& Values defining the order
Output value outElement Type& Element from the array
Output value outValue float& Median value
Output value outIndex int& Index of the median value

Errors

List of possible exceptions:

Error type Description
DomainError Empty input array in GetMedianElement.
DomainError Inconsistent array sizes in GetMedianElement.