Back to FabImage Library Lite website

You are here: Start » Geometry 2D » Geometry 2D Features » VectorsMedian

VectorsMedian


Header: FIL.h
Namespace: fil

Computes the geometric median of the input vectors.

Syntax

void fil::VectorsMedian
(
	const ftl::Array<fil::Vector2D>& inVectors,
	ftl::Optional<const ftl::Array<float>&> inWeights,
	const int inMaxIterationCount,
	fil::Vector2D& outGeometricMedian,
	ftl::Optional<float&> outDistanceSum = ftl::NIL,
	ftl::Array<fil::Vector2D>& diagApproximationSteps = ftl::Dummy<ftl::Array<Vector2D> >()
)

Parameters

Name Type Range Default Description
Input value inVectors const Array<Vector2D>& Input vectors
Input value inWeights Optional<const Array<float>&> NIL Optional input weights
Input value inMaxIterationCount const int 1 - 10 Maximum number of iterations
Output value outGeometricMedian Vector2D& Geometric median
Output value outDistanceSum Optional<float&> NIL Sum of distances from input vectors to geometric median
Diagnostic input diagApproximationSteps Array<Vector2D>& Approximate geometric medians calculated during subsequent iterations

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::NIL to these parameters: outDistanceSum.

Read more about Optional Outputs.

Errors

List of possible exceptions:

Error type Description
DomainError Input arrays must be of the same size in VectorsMedian.
DomainError Input vector array is empty in VectorsMedian.