You are here: Start » Function Reference » Clustering » ClusterPoints2D

ClusterPoints2D

Clusters 2D points using K Means Clustering method.

Header:	AVL.h

Syntax

void avl::ClusterPoints2D
(
	const atl::Array<avl::Point2D>& inPoints,
	const int inClusters,
	const int inMaxIterations,
	atl::Array<atl::Conditional<atl::Array<avl::Point2D>>>& outClusters,
	atl::Array<atl::Conditional<avl::Point2D>>& outCentroids,
	float& outDistanceSum
)

void ClusterPoints2D
(
	Point2D[] inPoints,
	int inClusters,
	int inMaxIterations,
	out Point2D[][] outClusters,
	out Point2D?[] outCentroids,
	out float outDistanceSum
)

Parameters

Name	Type	Range	Default	Description
inPoints	const Array<Point2D>&			Array of points to cluster
inClusters	const int	2 - +	2	Number of clusters to extract
inMaxIterations	const int	10 - 1000	200	Maximal number of KMeans iterations
outClusters	Array<Conditional<Array<Point2D>>>&			Resulting Point2D clusters
outCentroids	Array<Conditional<Point2D>>&			Center of found clusters
outDistanceSum	float&			Sum of distance squares from points in array to its respective cluster center