nag::kmeans_results< FPType > Struct Template Reference

A type used to hold the details of a k-means clustering analysis. More...

#include <SpecImage.hpp>

Public Member Functions
	kmeans_results (kmeans_results &&a)
	Move constructor. More...
	kmeans_results ()=default
	Default constructor. More...
kmeans_results &	operator= (kmeans_results &&a)
	Move assignment operator. More...

Data Fields
int	k
	The number of clusters in the analysis. More...
size_t	m
	The number of rows of the matrix. More...
size_t	n
	The number of columns of the matrix. More...
kmeans_metric_t	metric
	The distance metric used in the analysis. More...
std::unique_ptr< FPType[], cfree >	cmeans
	The k by n matrix whose rows define the k cluster centroids, stored in row-major ordering. More...
std::vector< int >	inc
	A vector of length m in which inc[i] indicates the cluster to which the \(i\)th pixel belongs. More...
std::vector< int >	nic
	A vector of length k in which nic[i] gives the number of pixels in the \(i\)th cluster. More...
std::vector< FPType >	wcs
	A vector of length k in which wcs[i] gives the within-cluster sum of distances to the \(i\)th cluster centroid. More...

Detailed Description

template<class FPType>
struct nag::kmeans_results< FPType >

A type used to hold the details of a k-means clustering analysis.

For more information see: nag::SpecImage::kmeans.

Constructor & Destructor Documentation

template<class FPType>

nag::kmeans_results< FPType >::kmeans_results ( kmeans_results< FPType > &&  a )

inline

Move constructor.

template<class FPType>

nag::kmeans_results< FPType >::kmeans_results ( )

default

Default constructor.

Member Function Documentation

template<class FPType>

kmeans_results& nag::kmeans_results< FPType >::operator= ( kmeans_results< FPType > &&  a )

inline

Move assignment operator.

Field Documentation

template<class FPType>

std::unique_ptr<FPType[], cfree> nag::kmeans_results< FPType >::cmeans

The k by n matrix whose rows define the k cluster centroids, stored in row-major ordering.

template<class FPType>

std::vector<int> nag::kmeans_results< FPType >::inc

A vector of length m in which inc[i] indicates the cluster to which the \(i\)th pixel belongs.

template<class FPType>

int nag::kmeans_results< FPType >::k

The number of clusters in the analysis.

template<class FPType>

size_t nag::kmeans_results< FPType >::m

The number of rows of the matrix.

template<class FPType>

kmeans_metric_t nag::kmeans_results< FPType >::metric

The distance metric used in the analysis.

template<class FPType>

size_t nag::kmeans_results< FPType >::n

The number of columns of the matrix.

template<class FPType>

std::vector<int> nag::kmeans_results< FPType >::nic

A vector of length k in which nic[i] gives the number of pixels in the \(i\)th cluster.

template<class FPType>

std::vector<FPType> nag::kmeans_results< FPType >::wcs

A vector of length k in which wcs[i] gives the within-cluster sum of distances to the \(i\)th cluster centroid.

---

The documentation for this struct was generated from the following file:

• SpecImage.hpp