#include <WsfClusterManager.hpp>

Inherits UtClusterManager.

Public Member Functions
	WsfClusterManager (WsfSimulation &aSimulation, size_t aNumClusters=0, UtClusterManager::ClusteringMethod aMethod=UtClusterManager::cK_MEANS, UtClusterManager::DistanceFunction aDistType=UtClusterManager::cPOSITION_ONLY)
	~WsfClusterManager () override=default

'utility' methods.
enum	DrawType { HULL , STAR }
unsigned int	UniqueId (const std::vector< WsfTrack * > &aList)
unsigned int	UniqueId (const std::vector< WsfPlatform * > &aList)
unsigned int	UniqueId (const std::vector< WsfGeoPoint * > &aList)
unsigned int	UniqueId (const std::vector< WsfAssetPerception * > &aList)
std::vector< WsfTrack * >	ConvexHull (const std::vector< WsfTrack * > &aList)
std::vector< WsfPlatform * >	ConvexHull (const std::vector< WsfPlatform * > &aList)
std::vector< WsfGeoPoint * >	ConvexHull (const std::vector< WsfGeoPoint * > &aList)
std::vector< WsfAssetPerception * >	ConvexHull (const std::vector< WsfAssetPerception * > &aList)
WsfGeoPoint	MeanLocation (const std::vector< WsfTrack * > &aList)
WsfGeoPoint	MeanLocation (const std::vector< WsfPlatform * > &aList)
WsfGeoPoint	MeanLocation (const std::vector< WsfGeoPoint * > &aList)
WsfGeoPoint	MeanLocation (const std::vector< WsfAssetPerception * > &aList)
WsfTrack *	NearestMember (const std::vector< WsfTrack * > &aList, WsfGeoPoint &toPoint)
WsfPlatform *	NearestMember (const std::vector< WsfPlatform * > &aList, WsfGeoPoint &toPoint)
WsfGeoPoint *	NearestMember (const std::vector< WsfGeoPoint * > &aList, WsfGeoPoint &toPoint)
WsfAssetPerception *	NearestMember (const std::vector< WsfAssetPerception * > &aList, WsfGeoPoint &toPoint)
void	NearestEdgePoint (const std::vector< WsfTrack * > &aList, WsfGeoPoint &toPoint, WsfGeoPoint &edgePoint, size_t &edgeIndex1, size_t &edgeIndex2)
void	NearestEdgePoint (const std::vector< WsfPlatform * > &aList, WsfGeoPoint &toPoint, WsfGeoPoint &edgePoint, size_t &edgeIndex1, size_t &edgeIndex2)
void	NearestEdgePoint (const std::vector< WsfGeoPoint * > &aList, WsfGeoPoint &toPoint, WsfGeoPoint &edgePoint, size_t &edgeIndex1, size_t &edgeIndex2)
void	NearestEdgePoint (const std::vector< WsfAssetPerception * > &aList, WsfGeoPoint &toPoint, WsfGeoPoint &edgePoint, size_t &edgeIndex1, size_t &edgeIndex2)
void	CrossLength (const std::vector< WsfTrack * > &aList, WsfGeoPoint &refPoint, double &dist1, WsfGeoPoint &leftPt, WsfGeoPoint &rightPt)
void	CrossLength (const std::vector< WsfPlatform * > &aList, WsfGeoPoint &refPoint, double &dist1, WsfGeoPoint &leftPt, WsfGeoPoint &rightPt)
void	CrossLength (const std::vector< WsfGeoPoint * > &aList, WsfGeoPoint &refPoint, double &dist1, WsfGeoPoint &leftPt, WsfGeoPoint &rightPt)
void	CrossLength (const std::vector< WsfAssetPerception * > &aList, WsfGeoPoint &refPoint, double &dist1, WsfGeoPoint &leftPt, WsfGeoPoint &rightPt)
void	Draw (const std::vector< WsfTrack * > &aList, double duration, UtVec3d &color, DrawType type=HULL)
void	Draw (const std::vector< WsfPlatform * > &aList, double duration, UtVec3d &color, DrawType type=HULL)
void	Draw (const std::vector< WsfGeoPoint * > &aList, double duration, UtVec3d &color, DrawType type=HULL)
void	Draw (const std::vector< WsfAssetPerception * > &aList, double duration, UtVec3d &color, DrawType type=HULL)
void	DrawHull (std::vector< UtClusterObject * > &cluster, double duration, UtVec3d &color)
void	DrawStar (std::vector< UtClusterObject * > &cluster, double duration, UtVec3d &color)

'configuration' methods.
bool	SetUserDistanceFunction (UtScriptContext *aScriptContextPtr, const std::string &aScoringFunctionName)
	finds and validates the script the user passed in as a scoring function
bool	UserDistanceFunction (UtClusterObject aObjectPtr, UtClusterObject aObject2Ptr, double &aDistance) override
WsfSimulation *	GetSimulation () const

'clustering' methods.
std::vector< std::vector< WsfTrack * > >	GetTrackClusters (WsfTrackList &aList)
std::vector< std::vector< WsfLocalTrack * > >	GetTrackClusters (WsfLocalTrackList &aList)
std::vector< std::vector< WsfTrack * > >	GetTrackClusters (const std::vector< WsfTrack * > &aList)
std::vector< std::vector< WsfLocalTrack * > >	GetTrackClusters (const std::vector< WsfLocalTrack * > &aList)
std::vector< std::vector< WsfPlatform * > >	GetPlatformClusters (const std::vector< WsfPlatform * > &aList)
std::vector< std::vector< WsfGeoPoint * > >	GetGeoPointClusters (const std::vector< WsfGeoPoint * > &aList)
std::vector< std::vector< WsfAssetPerception * > >	GetAssetClusters (const std::vector< WsfAssetPerception * > &aList)
void	Delete (std::vector< UtClusterObject * > &objects)

Detailed Description

A WsfClusterManager is a cluster creator & maintainer.

WsfClusterManager provides the processing desired for dynamic clustering. It is used to form clusters from an array or list of items. Cluster algorithms implemented at this time:

K-Means Clustering.
Hierarchical Tree Clustering, single-linkage.
Hierarchical Tree Clustering, complete-linkage.
Hierarchical Tree Clustering, average-linkage.

See also: WsfCluster

Member Enumeration Documentation

◆ DrawType

enum WsfClusterManager::DrawType

Enumerator
HULL
STAR

Constructor & Destructor Documentation

◆ WsfClusterManager()

WsfClusterManager::WsfClusterManager	(	WsfSimulation &	aSimulation,
		size_t	aNumClusters = 0,
		UtClusterManager::ClusteringMethod	aMethod = UtClusterManager::cK_MEANS,
		UtClusterManager::DistanceFunction	aDistType = UtClusterManager::cPOSITION_ONLY )

◆ ~WsfClusterManager()

WsfClusterManager::~WsfClusterManager ( )

overridedefault

References ConvexHull(), CrossLength(), Delete(), GetAssetClusters(), GetGeoPointClusters(), GetPlatformClusters(), GetTrackClusters(), MeanLocation(), NearestEdgePoint(), NearestMember(), and UniqueId().

Member Function Documentation

◆ ConvexHull() [1/4]

std::vector< WsfAssetPerception * > WsfClusterManager::ConvexHull ( const std::vector< WsfAssetPerception * > & aList )

References Delete(), WsfAssetClusterObject::GetAssets(), and WsfAssetClusterObject::GetObjects().

◆ ConvexHull() [2/4]

std::vector< WsfGeoPoint * > WsfClusterManager::ConvexHull ( const std::vector< WsfGeoPoint * > & aList )

References Delete(), WsfGeoPointClusterObject::GetGeoPoints(), and WsfGeoPointClusterObject::GetObjects().

◆ ConvexHull() [3/4]

std::vector< WsfPlatform * > WsfClusterManager::ConvexHull ( const std::vector< WsfPlatform * > & aList )

References Delete(), WsfPlatformClusterObject::GetObjects(), and WsfPlatformClusterObject::GetPlatforms().

◆ ConvexHull() [4/4]

std::vector< WsfTrack * > WsfClusterManager::ConvexHull ( const std::vector< WsfTrack * > & aList )

References Delete(), WsfTrackClusterObject::GetObjects(), GetSimulation(), and WsfTrackClusterObject::GetTracks().

Referenced by WsfScriptClusterManagerClass::WsfScriptClusterManagerClass(), and ~WsfClusterManager().

◆ CrossLength() [1/4]

void WsfClusterManager::CrossLength	(	const std::vector< WsfAssetPerception * > &	aList,
		WsfGeoPoint &	refPoint,
		double &	dist1,
		WsfGeoPoint &	leftPt,
		WsfGeoPoint &	rightPt )

References Delete(), WsfGeoPoint::GetLocationWCS(), WsfAssetClusterObject::GetObjects(), and WsfGeoPoint::SetLocationWCS().

◆ CrossLength() [2/4]

void WsfClusterManager::CrossLength	(	const std::vector< WsfGeoPoint * > &	aList,
		WsfGeoPoint &	refPoint,
		double &	dist1,
		WsfGeoPoint &	leftPt,
		WsfGeoPoint &	rightPt )

References Delete(), WsfGeoPoint::GetLocationWCS(), WsfGeoPointClusterObject::GetObjects(), and WsfGeoPoint::SetLocationWCS().

◆ CrossLength() [3/4]

void WsfClusterManager::CrossLength	(	const std::vector< WsfPlatform * > &	aList,
		WsfGeoPoint &	refPoint,
		double &	dist1,
		WsfGeoPoint &	leftPt,
		WsfGeoPoint &	rightPt )

References Delete(), WsfGeoPoint::GetLocationWCS(), WsfPlatformClusterObject::GetObjects(), and WsfGeoPoint::SetLocationWCS().

◆ CrossLength() [4/4]

void WsfClusterManager::CrossLength	(	const std::vector< WsfTrack * > &	aList,
		WsfGeoPoint &	refPoint,
		double &	dist1,
		WsfGeoPoint &	leftPt,
		WsfGeoPoint &	rightPt )

References Delete(), WsfGeoPoint::GetLocationWCS(), WsfTrackClusterObject::GetObjects(), GetSimulation(), and WsfGeoPoint::SetLocationWCS().

Referenced by ~WsfClusterManager().

◆ Delete()

void WsfClusterManager::Delete ( std::vector< UtClusterObject * > & objects )

◆ Draw() [1/4]

void WsfClusterManager::Draw	(	const std::vector< WsfAssetPerception * > &	aList,
		double	duration,
		UtVec3d &	color,
		DrawType	type = HULL )

References Delete(), DrawHull(), DrawStar(), WsfAssetClusterObject::GetObjects(), and STAR.

◆ Draw() [2/4]

void WsfClusterManager::Draw	(	const std::vector< WsfGeoPoint * > &	aList,
		double	duration,
		UtVec3d &	color,
		DrawType	type = HULL )

References Delete(), DrawHull(), DrawStar(), WsfGeoPointClusterObject::GetObjects(), and STAR.

◆ Draw() [3/4]

void WsfClusterManager::Draw	(	const std::vector< WsfPlatform * > &	aList,
		double	duration,
		UtVec3d &	color,
		DrawType	type = HULL )

References Delete(), DrawHull(), DrawStar(), WsfPlatformClusterObject::GetObjects(), and STAR.

◆ Draw() [4/4]

void WsfClusterManager::Draw	(	const std::vector< WsfTrack * > &	aList,
		double	duration,
		UtVec3d &	color,
		DrawType	type = HULL )

References Delete(), DrawHull(), DrawStar(), WsfTrackClusterObject::GetObjects(), GetSimulation(), and STAR.

◆ DrawHull()

void WsfClusterManager::DrawHull	(	std::vector< UtClusterObject * > &	cluster,
		double	duration,
		UtVec3d &	color )

References GetSimulation().

Referenced by Draw(), Draw(), Draw(), and Draw().

◆ DrawStar()

void WsfClusterManager::DrawStar	(	std::vector< UtClusterObject * > &	cluster,
		double	duration,
		UtVec3d &	color )

References GetSimulation().

Referenced by Draw(), Draw(), Draw(), and Draw().

◆ GetAssetClusters()

std::vector< std::vector< WsfAssetPerception * > > WsfClusterManager::GetAssetClusters ( const std::vector< WsfAssetPerception * > & aList )

References Delete(), WsfAssetClusterObject::GetAssets(), and WsfAssetClusterObject::GetObjects().

Referenced by WsfScriptClusterManagerClass::WsfScriptClusterManagerClass(), and ~WsfClusterManager().

◆ GetGeoPointClusters()

std::vector< std::vector< WsfGeoPoint * > > WsfClusterManager::GetGeoPointClusters ( const std::vector< WsfGeoPoint * > & aList )

References Delete(), WsfGeoPointClusterObject::GetGeoPoints(), and WsfGeoPointClusterObject::GetObjects().

Referenced by WsfScriptClusterManagerClass::WsfScriptClusterManagerClass(), and ~WsfClusterManager().

◆ GetPlatformClusters()

std::vector< std::vector< WsfPlatform * > > WsfClusterManager::GetPlatformClusters ( const std::vector< WsfPlatform * > & aList )

References Delete(), WsfPlatformClusterObject::GetObjects(), and WsfPlatformClusterObject::GetPlatforms().

Referenced by WsfScriptClusterManagerClass::WsfScriptClusterManagerClass(), and ~WsfClusterManager().

◆ GetSimulation()

WsfSimulation * WsfClusterManager::GetSimulation ( ) const

inline

Referenced by ConvexHull(), CrossLength(), Draw(), DrawHull(), DrawStar(), GetTrackClusters(), GetTrackClusters(), GetTrackClusters(), GetTrackClusters(), MeanLocation(), NearestEdgePoint(), NearestMember(), UniqueId(), and UserDistanceFunction().

◆ GetTrackClusters() [1/4]

std::vector< std::vector< WsfLocalTrack * > > WsfClusterManager::GetTrackClusters ( const std::vector< WsfLocalTrack * > & aList )

References Delete(), WsfTrackClusterObject::GetObjects(), GetSimulation(), and WsfTrackClusterObject::GetTracks().

◆ GetTrackClusters() [2/4]

std::vector< std::vector< WsfTrack * > > WsfClusterManager::GetTrackClusters ( const std::vector< WsfTrack * > & aList )

References Delete(), WsfTrackClusterObject::GetObjects(), GetSimulation(), and WsfTrackClusterObject::GetTracks().

◆ GetTrackClusters() [3/4]

std::vector< std::vector< WsfLocalTrack * > > WsfClusterManager::GetTrackClusters ( WsfLocalTrackList & aList )

References Delete(), WsfTrackClusterObject::GetObjects(), GetSimulation(), and WsfTrackClusterObject::GetTracks().

◆ GetTrackClusters() [4/4]

std::vector< std::vector< WsfTrack * > > WsfClusterManager::GetTrackClusters ( WsfTrackList & aList )

References Delete(), WsfTrackClusterObject::GetObjects(), GetSimulation(), and WsfTrackClusterObject::GetTracks().

Referenced by WsfScriptClusterManagerClass::WsfScriptClusterManagerClass(), and ~WsfClusterManager().

◆ MeanLocation() [1/4]

WsfGeoPoint WsfClusterManager::MeanLocation ( const std::vector< WsfAssetPerception * > & aList )

References Delete(), and WsfAssetClusterObject::GetObjects().

◆ MeanLocation() [2/4]

WsfGeoPoint WsfClusterManager::MeanLocation ( const std::vector< WsfGeoPoint * > & aList )

References Delete(), and WsfGeoPointClusterObject::GetObjects().

◆ MeanLocation() [3/4]

WsfGeoPoint WsfClusterManager::MeanLocation ( const std::vector< WsfPlatform * > & aList )

References Delete(), and WsfPlatformClusterObject::GetObjects().

◆ MeanLocation() [4/4]

WsfGeoPoint WsfClusterManager::MeanLocation ( const std::vector< WsfTrack * > & aList )

References Delete(), WsfTrackClusterObject::GetObjects(), and GetSimulation().

Referenced by WsfScriptClusterManagerClass::WsfScriptClusterManagerClass(), and ~WsfClusterManager().

◆ NearestEdgePoint() [1/4]

void WsfClusterManager::NearestEdgePoint	(	const std::vector< WsfAssetPerception * > &	aList,
		WsfGeoPoint &	toPoint,
		WsfGeoPoint &	edgePoint,
		size_t &	edgeIndex1,
		size_t &	edgeIndex2 )

References Delete(), WsfAssetClusterObject::GetObjects(), and WsfGeoPoint::SetLocationWCS().

◆ NearestEdgePoint() [2/4]

void WsfClusterManager::NearestEdgePoint	(	const std::vector< WsfGeoPoint * > &	aList,
		WsfGeoPoint &	toPoint,
		WsfGeoPoint &	edgePoint,
		size_t &	edgeIndex1,
		size_t &	edgeIndex2 )

References Delete(), WsfGeoPointClusterObject::GetObjects(), and WsfGeoPoint::SetLocationWCS().

◆ NearestEdgePoint() [3/4]

void WsfClusterManager::NearestEdgePoint	(	const std::vector< WsfPlatform * > &	aList,
		WsfGeoPoint &	toPoint,
		WsfGeoPoint &	edgePoint,
		size_t &	edgeIndex1,
		size_t &	edgeIndex2 )

References Delete(), WsfPlatformClusterObject::GetObjects(), and WsfGeoPoint::SetLocationWCS().

◆ NearestEdgePoint() [4/4]

void WsfClusterManager::NearestEdgePoint	(	const std::vector< WsfTrack * > &	aList,
		WsfGeoPoint &	toPoint,
		WsfGeoPoint &	edgePoint,
		size_t &	edgeIndex1,
		size_t &	edgeIndex2 )

References Delete(), WsfTrackClusterObject::GetObjects(), GetSimulation(), and WsfGeoPoint::SetLocationWCS().

Referenced by ~WsfClusterManager().

◆ NearestMember() [1/4]

WsfAssetPerception * WsfClusterManager::NearestMember	(	const std::vector< WsfAssetPerception * > &	aList,
		WsfGeoPoint &	toPoint )

References Delete(), and WsfAssetClusterObject::GetObjects().

◆ NearestMember() [2/4]

WsfGeoPoint * WsfClusterManager::NearestMember	(	const std::vector< WsfGeoPoint * > &	aList,
		WsfGeoPoint &	toPoint )

References Delete(), and WsfGeoPointClusterObject::GetObjects().

◆ NearestMember() [3/4]

WsfPlatform * WsfClusterManager::NearestMember	(	const std::vector< WsfPlatform * > &	aList,
		WsfGeoPoint &	toPoint )

References Delete(), and WsfPlatformClusterObject::GetObjects().

◆ NearestMember() [4/4]

WsfTrack * WsfClusterManager::NearestMember	(	const std::vector< WsfTrack * > &	aList,
		WsfGeoPoint &	toPoint )

References Delete(), WsfTrackClusterObject::GetObjects(), and GetSimulation().

Referenced by WsfScriptClusterManagerClass::WsfScriptClusterManagerClass(), and ~WsfClusterManager().

◆ SetUserDistanceFunction()

bool WsfClusterManager::SetUserDistanceFunction	(	UtScriptContext *	aScriptContextPtr,
		const std::string &	aScoringFunctionName )

finds and validates the script the user passed in as a scoring function

◆ UniqueId() [1/4]

unsigned int WsfClusterManager::UniqueId ( const std::vector< WsfAssetPerception * > & aList )

References Delete(), and WsfAssetClusterObject::GetObjects().

◆ UniqueId() [2/4]

unsigned int WsfClusterManager::UniqueId ( const std::vector< WsfGeoPoint * > & aList )

References Delete(), and WsfGeoPointClusterObject::GetObjects().

◆ UniqueId() [3/4]

unsigned int WsfClusterManager::UniqueId ( const std::vector< WsfPlatform * > & aList )

References Delete(), and WsfPlatformClusterObject::GetObjects().

◆ UniqueId() [4/4]

unsigned int WsfClusterManager::UniqueId ( const std::vector< WsfTrack * > & aList )

References Delete(), WsfTrackClusterObject::GetObjects(), and GetSimulation().

Referenced by WsfScriptClusterManagerClass::WsfScriptClusterManagerClass(), and ~WsfClusterManager().

◆ UserDistanceFunction()

bool WsfClusterManager::UserDistanceFunction	(	UtClusterObject *	aObjectPtr,
		UtClusterObject *	aObject2Ptr,
		double &	aDistance )

override

References WsfSimulation::GetScriptExecutor(), and GetSimulation().

The documentation for this class was generated from the following files:

Public Member Functions

'utility' methods.

'configuration' methods.

'clustering' methods.

Detailed Description

Member Enumeration Documentation

◆ DrawType

Constructor & Destructor Documentation

◆ WsfClusterManager()

◆ ~WsfClusterManager()

Member Function Documentation

◆ ConvexHull() [1/4]

◆ ConvexHull() [2/4]

◆ ConvexHull() [3/4]

◆ ConvexHull() [4/4]

◆ CrossLength() [1/4]

◆ CrossLength() [2/4]

◆ CrossLength() [3/4]

◆ CrossLength() [4/4]

◆ Delete()

◆ Draw() [1/4]

◆ Draw() [2/4]

◆ Draw() [3/4]

◆ Draw() [4/4]

◆ DrawHull()

◆ DrawStar()

◆ GetAssetClusters()

◆ GetGeoPointClusters()

◆ GetPlatformClusters()

◆ GetSimulation()

◆ GetTrackClusters() [1/4]

◆ GetTrackClusters() [2/4]

◆ GetTrackClusters() [3/4]

◆ GetTrackClusters() [4/4]

◆ MeanLocation() [1/4]

◆ MeanLocation() [2/4]

◆ MeanLocation() [3/4]

◆ MeanLocation() [4/4]

◆ NearestEdgePoint() [1/4]

◆ NearestEdgePoint() [2/4]

◆ NearestEdgePoint() [3/4]

◆ NearestEdgePoint() [4/4]

◆ NearestMember() [1/4]

◆ NearestMember() [2/4]

◆ NearestMember() [3/4]

◆ NearestMember() [4/4]

◆ SetUserDistanceFunction()

◆ UniqueId() [1/4]

◆ UniqueId() [2/4]

◆ UniqueId() [3/4]

◆ UniqueId() [4/4]

◆ UserDistanceFunction()