Back to FabImage Library websiteYou are here:
Start »
Function Reference »
All Functions »
Array Statistics »
GetMedianElement_OrNil
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 array element corresponding to median value from the inValues array; returns NIL if the arrays are empty.
Syntax
void fil::GetMedianElement_OrNil
(
const ftl::Array<Type>& inArray,
const ftl::Array<float>& inValues,
typename ftl::ToConditionalType<Type>::Type& outElement,
ftl::Conditional<float>& outValue,
ftl::Conditional<int>& outIndex
)
Parameters
|
Name |
Type |
Default |
Description |
 |
inArray |
const Array<Type>& |
|
Elements from which element corresponding to median value will be chosen |
 |
inValues |
const Array<float>& |
|
Values defining the order |
 |
outElement |
typename ToConditionalType<Type>::Type& |
|
Element from the array |
 |
outValue |
Conditional<float>& |
|
Median value |
 |
outIndex |
Conditional<int>& |
|
Index of the median value |
Errors
List of possible exceptions:
Error type |
Description |
DomainError |
Inconsistent array sizes in GetMedianElement_OrNil. |