aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/lipi-toolkit/3rdparty/lipi-toolkit/src/reco/shaperec/activedtw/ActiveDTWClusterModel.h
blob: 4d183487690291e65939b32edfc256bc73620a74 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
/*****************************************************************************************
* Copyright (c) 2006 Hewlett-Packard Development Company, L.P.
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
* Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies 
* or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
* CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
* OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*****************************************************************************************/
/************************************************************************
* SVN MACROS
*
* $LastChangedDate: 2011-01-11 13:48:17 +0530 (Tue, 11 Jan 2011) $
* $Revision: 827 $
* $Author: mnab $
*
************************************************************************/
/*********************************************************************************************
* FILE DESCR: Definitions for ActiveDTWClusterModel Class
*
* CONTENTS:
*
* AUTHOR: S Anand
* DATE:3-MAR-2009
* CHANGE HISTORY:
* Author       Date            Description of change
***********************************************************************************************/


#ifndef ACTIVEDTWCLUSTERMODEL_H
#define ACTIVEDTWCLUSTERMODEL_H

#include <iostream>
#include "LTKTypes.h"
#include "LTKInc.h"
#include "LTKMacros.h"
#include "LTKErrors.h"
#include "LTKErrorsList.h"

using namespace std;

typedef vector<double> doubleVector;
typedef vector<doubleVector> double2DVector;

/**
* @ingroup ActiveDTWShapeModel.h
* @brief The Header file for the ActiveDTWShapeModel
* @class ActiveDTWShapeModel
*<p> <p>
*/
class ActiveDTWClusterModel
{
private:
	int m_numberOfSamples;
	/** @brief Number of samples in the cluster 
	*     <p>
	*     Specifies the number of samples in the cluster 
	*     </p>
	*/
	
	doubleVector m_eigenValues;
	/** @brief Eigen Values
	*     <p>
	*     Eigen values of the cluster covariance matrix 
	*     </p>
	*/
	
	double2DVector m_eigenVectors;
	/** @brief Eigen Vectors
	*     <p>
	*     Eigen vectors of the cluster covariance matrix
	*     </p>
	*/
	
	doubleVector m_clusterMean;
	/** @brief Cluster mean
	*     <p>
	*     Mean of all the samples forming the cluster 
	*     </p>
	*/
	
public:
	
	/** @name Constructors and Destructor */
	ActiveDTWClusterModel();
	
	~ActiveDTWClusterModel();
	
	/**
	* Sets the number of samples in the cluster 
	* @param numSamples
	* @return SUCCESS : if the number of samples was set successfully
	* @exception EINVALID_SHAPEID
	*/
	int setNumSamples(int numSamples);
	
	/**
	* Sets the eigen values of the cluser
	* @param eigVal
	* @return SUCCESS : if the number of samples was set successfully
	* @exception EINVALID_SHAPEID
	*/
	void setEigenValues(const doubleVector& eigVal);
	
	/**
	* Sets the eigen vectors of the cluster
	* @param eigVec
	* @return SUCCESS : if the number of samples was set successfully
	* @exception EINVALID_SHAPEID
	*/
	void setEigenVectors(const double2DVector& eigVec);
	
	/**
	* Sets the mean of the cluster 
	* @param clusterMean
	* @return SUCCESS : if the number of samples was set successfully
	* @exception EINVALID_SHAPEID
	*/
	void setClusterMean(const doubleVector& clusterMean);
	
	/**
	* Returns the number of samples in the cluster 
	* @return number of samples
	* @exception EINVALID_SHAPEID
	*/
	int getNumSamples() const;
	
	/**
	* Returns the eigen values of the cluster
	* @return eigen values 
	* @exception EINVALID_SHAPEID
	*/
	const doubleVector& getEigenValues() const;
	
	/**
	* Returns the eigen vectors of the cluster
	* @return eigen vectors 
	* @exception EINVALID_SHAPEID
	*/
	const double2DVector& getEigenVectors() const;
	
	/**
	* Returns the mean of the cluster
	* @return cluster mean
	* @exception EINVALID_SHAPEID
	*/
	const doubleVector& getClusterMean() const;
	
	
};
#endif