Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
rtc::PrincipalComponentAnalysis< T, N > Class Template Reference

#include <rtcPCA.h>

List of all members.

Public Types

typedef std::vector< Vec< T, N > > VecData

Public Member Functions

SMat< T, N > & computeTransformMatrix (const VecData &data)
 Compute transform matrix.
SMat< T, N > & computeTransformMatrix (const VarMat< T > &data)
 Compute transform matrix.
 PrincipalComponentAnalysis ()
 Constructor.
Vec< T, N > & transform (const Vec< T, N > &src, Vec< T, N > &dest) const
 Transforms a single vector according to a previously computed transformation matrix.
Vec< T, N > & transform (Vec< T, N > &srcdest) const
 Transforms a single vector according to a previously computed transformation matrix.
VarMat< T > & transform (VarMat< T > &data) const
 Transforms the data according to a previously computed transformation matrix.
VecDatatransform (VecData &data) const
 Transforms the data according to a previously computed transformation matrix.
 ~PrincipalComponentAnalysis ()
 Destructor.

Public Attributes

SMat< T, N > correlation_coefficient
Vec< T, N > eigen_values
SMat< T, N > eigen_vectors
Vec< T, N > offset
SMat< T, N > transform_matrix

Protected Member Functions

SMat< T, N > & covarianceMatrixOfRows (const VecData &src, SMat< T, N > &covariance) const
Vec< T, N > & meanOfRows (const VecData &src, Vec< T, N > &mean) const

Protected Attributes

bool transform_matrix_computed

Detailed Description

template<class T, int N>
class rtc::PrincipalComponentAnalysis< T, N >

It receives a set of input vectors in form of a matrix (each row of the matrix corresponds to an input vector), which will be transformed with PCA.

Definition at line 37 of file rtcPCA.h.


Member Typedef Documentation

template<class T, int N>
typedef std::vector< Vec<T,N> > rtc::PrincipalComponentAnalysis< T, N >::VecData

Definition at line 40 of file rtcPCA.h.


Constructor & Destructor Documentation

template<class T , int N>
rtc::PrincipalComponentAnalysis< T, N >::PrincipalComponentAnalysis ( ) [inline]

Constructor.

Ctor that accepts system matrix.

Definition at line 81 of file rtcPCA.h.

template<class T , int N>
rtc::PrincipalComponentAnalysis< T, N >::~PrincipalComponentAnalysis ( ) [inline]

Destructor.

Dtor to delete memory and indicate conclusion

Definition at line 88 of file rtcPCA.h.


Member Function Documentation

template<class T , int N>
SMat< T, N > & rtc::PrincipalComponentAnalysis< T, N >::computeTransformMatrix ( const VecData data) [inline]

Compute transform matrix.

Definition at line 93 of file rtcPCA.h.

template<class T , int N>
SMat< T, N > & rtc::PrincipalComponentAnalysis< T, N >::computeTransformMatrix ( const VarMat< T > &  data) [inline]

Compute transform matrix.

Definition at line 117 of file rtcPCA.h.

template<class T , int N>
SMat< T, N > & rtc::PrincipalComponentAnalysis< T, N >::covarianceMatrixOfRows ( const VecData src,
SMat< T, N > &  covariance 
) const [inline, protected]

Definition at line 228 of file rtcPCA.h.

template<class T , int N>
Vec< T, N > & rtc::PrincipalComponentAnalysis< T, N >::meanOfRows ( const VecData src,
Vec< T, N > &  mean 
) const [inline, protected]

The meanOfRows means the mean of all rows, i.e. a row vector containing (for the arithmetical mean) the sum of all row vectors divided by the number of rows.

Definition at line 217 of file rtcPCA.h.

template<class T , int N>
Vec< T, N > & rtc::PrincipalComponentAnalysis< T, N >::transform ( const Vec< T, N > &  src,
Vec< T, N > &  dest 
) const [inline]

Transforms a single vector according to a previously computed transformation matrix.

Definition at line 150 of file rtcPCA.h.

template<class T , int N>
Vec< T, N > & rtc::PrincipalComponentAnalysis< T, N >::transform ( Vec< T, N > &  srcdest) const [inline]

Transforms a single vector according to a previously computed transformation matrix.

Definition at line 166 of file rtcPCA.h.

template<class T , int N>
VarMat< T > & rtc::PrincipalComponentAnalysis< T, N >::transform ( VarMat< T > &  data) const [inline]

Transforms the data according to a previously computed transformation matrix.

Definition at line 182 of file rtcPCA.h.

template<class T , int N>
std::vector< Vec< T, N > > & rtc::PrincipalComponentAnalysis< T, N >::transform ( VecData data) const [inline]

Transforms the data according to a previously computed transformation matrix.

Definition at line 201 of file rtcPCA.h.


Member Data Documentation

template<class T, int N>
SMat<T,N> rtc::PrincipalComponentAnalysis< T, N >::correlation_coefficient

Definition at line 71 of file rtcPCA.h.

template<class T, int N>
Vec<T,N> rtc::PrincipalComponentAnalysis< T, N >::eigen_values

Definition at line 74 of file rtcPCA.h.

template<class T, int N>
SMat<T,N> rtc::PrincipalComponentAnalysis< T, N >::eigen_vectors

Definition at line 72 of file rtcPCA.h.

template<class T, int N>
Vec<T,N> rtc::PrincipalComponentAnalysis< T, N >::offset

Definition at line 70 of file rtcPCA.h.

template<class T, int N>
SMat<T,N> rtc::PrincipalComponentAnalysis< T, N >::transform_matrix

Definition at line 73 of file rtcPCA.h.

template<class T, int N>
bool rtc::PrincipalComponentAnalysis< T, N >::transform_matrix_computed [protected]

Definition at line 67 of file rtcPCA.h.


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


rtc
Author(s): Benjamin Pitzer
autogenerated on Thu Jan 2 2014 11:04:54