iRoCS Toolbox  1.1.0
Data Structures | Public Member Functions
segmentation::_KMeans< DataT > Class Template Reference

#include <kmeans.hh>

Collaboration diagram for segmentation::_KMeans< DataT >:

Data Structures

struct  Distance
 
struct  EuclideanDistance
 

Public Member Functions

 _KMeans (const unsigned int k, const Distance &distance)
 
 _KMeans (const unsigned int k)
 
virtual ~_KMeans ()
 
double cluster (const ArrayPointT &points, ArrayPointT &means, std::vector< int > &labels)
 
void setMaxIterations (int max_iterations)
 set maximum number of iterations More...
 
void setMaxIterations (double threshold)
 Set variance threshold. More...
 
void setMaxRestarts (int max_restarts)
 set maximum number of restarts to perform for variance minimization More...
 
void setRestartStopThreshold (int iter)
 stop restarts if variance didn't drop for iter iterations More...
 

Detailed Description

template<class DataT>
class segmentation::_KMeans< DataT >

Definition at line 38 of file kmeans.hh.

Constructor & Destructor Documentation

◆ _KMeans() [1/2]

template<class DataT>
segmentation::_KMeans< DataT >::_KMeans ( const unsigned int  k,
const Distance distance 
)

◆ _KMeans() [2/2]

template<class DataT >
segmentation::_KMeans< DataT >::_KMeans ( const unsigned int  k)

Definition at line 57 of file kmeans-inl.hh.

◆ ~_KMeans()

template<class DataT >
segmentation::_KMeans< DataT >::~_KMeans ( )
virtual

Definition at line 68 of file kmeans-inl.hh.

Member Function Documentation

◆ cluster()

template<class DataT >
double segmentation::_KMeans< DataT >::cluster ( const ArrayPointT &  points,
ArrayPointT &  means,
std::vector< int > &  labels 
)

Definition at line 74 of file kmeans-inl.hh.

Referenced by segmentation::kmeans().

◆ setMaxRestarts()

template<class DataT>
void segmentation::_KMeans< DataT >::setMaxRestarts ( int  max_restarts)
inline

set maximum number of restarts to perform for variance minimization

Parameters
max_restartsmaximum number of restarts to perform

Definition at line 64 of file kmeans.hh.

◆ setMaxIterations() [1/2]

template<class DataT>
void segmentation::_KMeans< DataT >::setMaxIterations ( int  max_iterations)
inline

set maximum number of iterations

Parameters
max_iterationsmaximum number of iterations

Definition at line 72 of file kmeans.hh.

◆ setMaxIterations() [2/2]

template<class DataT>
void segmentation::_KMeans< DataT >::setMaxIterations ( double  threshold)
inline

Set variance threshold.

No further restart is performed if total variance drops below this threshold

Definition at line 80 of file kmeans.hh.

◆ setRestartStopThreshold()

template<class DataT>
void segmentation::_KMeans< DataT >::setRestartStopThreshold ( int  iter)
inline

stop restarts if variance didn't drop for iter iterations

Definition at line 87 of file kmeans.hh.


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