Back to FabImage Studio website
You are here: Start » Filter Reference » Array Statistics » GetMaximumElement
GetMaximumElement
Returns an array element that corresponds to the biggest value in the array of values.
| Name | Type | Description | |
|---|---|---|---|
 |
inArray | <T>Array | Elements from which element corresponding to biggest value will be chosen |
|
inValues | RealArray | Values defining the order |
 |
outElement | <T> | Element from the array |
|
outValue | Real | Biggest value |
|
outIndex | Integer | Index of the biggest value |
The type of this filter is defined using the type variable T which represents any valid type. Read more.
Applications
Choosing one object from an array on the basis of some feature, e.g. the blob having the highest area.
Hints
- If the input array is not guaranteed to be non-empty, use GetMaximumElement_OrNil instead.
Errors
This filter can throw an exception to report error. Read how to deal with errors here: Error Handling
| Error type | Description |
|---|---|
| DomainError | Inconsistent array sizes in GetMaximumElement. |
| DomainError | Empty input array in GetMaximumElement. |
Complexity Level
This filter is available on Basic Complexity Level.
Filter Group
This filters is member of GetMaximumElement filter group.
