Back to Aurora Vision Library Lite website
You are here: Start » Geometry 2D » Geometry 2D Features » VectorsMedian
VectorsMedian
Header: | AVL.h |
---|---|
Namespace: | avl |
Computes the geometric median of the input vectors.
Syntax
void avl::VectorsMedian ( const atl::Array<avl::Vector2D>& inVectors, atl::Optional<const atl::Array<float>&> inWeights, const int inMaxIterationCount, avl::Vector2D& outGeometricMedian, atl::Optional<float&> outDistanceSum = atl::NIL, atl::Array<avl::Vector2D>& diagApproximationSteps = atl::Dummy<atl::Array<Vector2D> >() )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inVectors | const Array<Vector2D>& | Input vectors | |||
inWeights | Optional<const Array<float>&> | NIL | Optional input weights | ||
inMaxIterationCount | const int | 1 - | 10 | Maximum number of iterations | |
outGeometricMedian | Vector2D& | Geometric median | |||
outDistanceSum | Optional<float&> | NIL | Sum of distances from input vectors to geometric median | ||
diagApproximationSteps | Array<Vector2D>& | 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 VectorsMedian. |
DomainError | Input vector array is empty in VectorsMedian. |