Back to Aurora Vision Library Lite website
You are here: Start » Geometry 2D » Geometry 2D Features » PointsMedian
PointsMedian
Header: | AVL.h |
---|---|
Namespace: | avl |
Computes the geometric median of the input points.
Syntax
void avl::PointsMedian ( const atl::Array<avl::Point2D>& inPoints, atl::Optional<const atl::Array<float>&> inWeights, const int inMaxIterationCount, avl::Point2D& outGeometricMedian, atl::Optional<float&> outDistanceSum = atl::NIL, atl::Array<avl::Point2D>& diagApproximationSteps = atl::Dummy<atl::Array<Point2D> >() )
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 atl::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 PointsMedian. |
DomainError | Input point array is empty in PointsMedian. |