You are here: Start » Function Reference » Geometry 2D Features » PointsMedian

PointsMedian

Header:	FIL.h
Namespace:	fil

Computes the geometric median of the input points.

Syntax

void fil::PointsMedian
(
	const ftl::Array<fil::Point2D>& inPoints,
	ftl::Optional<const ftl::Array<float>&> inWeights,
	const int inMaxIterationCount,
	fil::Point2D& outGeometricMedian,
	ftl::Optional<float&> outDistanceSum = ftl::NIL,
	ftl::Array<fil::Point2D>& diagApproximationSteps = ftl::Dummy&lt;ftl::Array&lt;Point2D&gt;&nbsp;&gt;()
)

Parameters

Name	Type	Range	Default	Description
inPoints	const Array<Point2D>&			Input points
inWeights	Optional<const Array<float>&>		NIL	Optional input weights
inMaxIterationCount	const int	1 -	10	Maximum number of iterations
outGeometricMedian	Point2D&			Geometric median
outDistanceSum	Optional<float&>		NIL	Sum of distances from input points to geometric median
diagApproximationSteps	Array<Point2D>&			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.

Errors

List of possible exceptions:

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