aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/lipi-toolkit/3rdparty/lipi-toolkit/src/reco/shaperec/featureextractor/pointfloat/PointFloatShapeFeature.h
blob: 4e05a0ca9cec0ea9f0cf3394d819516c8a1b94c3 (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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
/*****************************************************************************************
* 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: 2009-07-01 20:12:22 +0530 (Wed, 01 Jul 2009) $
 * $Revision: 784 $
 * $Author: mnab $
 *
 ************************************************************************/
#ifndef __POINTFLOATSHAPEFEATURE_H
#define __POINTFLOATSHAPEFEATURE_H

#include "LTKShapeFeature.h"


/** @defgroup PointFloatShapeFeatureExtractor
*/

/** @ingroup PointFloatShapeFeatureExtractor
* @brief The feature representation class for X, Y features (float)
* @class PointFloatShapeFeature
*
*/
class PointFloatShapeFeature : public LTKShapeFeature
{
	/** @name private data members */
	//@{

private:
	/** @brief X value  */
	float m_x;					

	/** @brief Y value  */
	float m_y;			
	
	/** @brief sin theta value  */
	float m_sinTheta;

	/** @brief cos theta value  */
	float m_cosTheta;

	/** @brief Pen-up information */
	bool m_penUp;

	/** @brief Delimiter character  */
    static const string m_data_delimiter;
	//@}
	
public:
	
	/** @name Constructors and Destructor */
	//@{

	/**
	* Default Constructor.
	*/
	PointFloatShapeFeature();

    /** Parameterized Constructor */
    PointFloatShapeFeature(float inX, float inY, float inSinTheta,
                           float inCosTheta, bool inPenUp);
    
	/**
	* Default destructor.
	*/
	~PointFloatShapeFeature();
	
	/**
	* Returns the value of class data member PointFloatShapeFeature::m_x
	*/
	float getX() const;

	/**
	* Returns the value of PointFloatShapeFeature::m_y
	*/
	float getY() const;

	/**
	* Returns the value of PointFloatShapeFeature::m_sinTheta
	*/
	float getSinTheta() const;

	/**
	* Returns the value of PointFloatShapeFeature::m_cosTheta
	*/
	float getCosTheta() const;

	bool isPenUp() const;


	/**
	* Sets the value of PointFloatShapeFeature::m_x
	*/	

	void setX(float x);

	/**
	* Sets the value of PointFloatShapeFeature::m_y
	*/	
	void setY(float y);

	/**
	* Sets the value of PointFloatShapeFeature::m_sinTheta
	*/	

    //int setSinTheta(float y);
	void setSinTheta(float y);

	
	/**
	* Sets the value of PointFloatShapeFeature::m_cosTheta
	*/	
	//int setCosTheta(float y);
	void setCosTheta(float y);


	void setPenUp(bool penUp);
	/**
	* @brief Initializes the PointFloatShapeFeature from the string passed as parameter.
	*
	* <b>Semantics</b>
	*
	*	- Tokenize the input string on PointFloatShapeFeature::m_data_delimiter using StringTokenizer::tokenizeString
	*	- Initialize the data members of the class with the tokens returned.
	*
	* @param initString : string& : Reference to the initialization string.
	*
	* @return FAILURE : If the initalization string contains more than two tokens (after tokenizing on PointFloatShapeFeature::m_data_delimiter)
	* @return SUCCESS : If initialization done without any errors.
	*	
	*/
	int initialize(const string& initString);

    int initialize(const floatVector& initFloatVector);

    int initialize(floatVector::const_pointer initFloatData, size_t dataSize);

    int toFloatVector(vector<float>& floatVec);

	/**
	* @brief  Gives the string representation of the PointFloatShapeFeature instance
	*/	
	void toString(string& strFeat) const;
	/**
	* This method sets the value of x
	*/	

	LTKShapeFeaturePtr clone() const;

    void getDistance(const LTKShapeFeaturePtr& shapeFeaturePtr, float& outDistance) const;

    

	/**
	* @brief Adds two PoinFloatShapeFeature instances.
	*
	* @param secondFeature : LTKShapeFeature* : Base class pointer holding pointer to PointFloatShapeFeature instance
	*
	* @return LTKShapeFeature* : Pointer to PointFloatShapeFeature instance holding the result of addition.
	*	
	*/
	int addFeature(const LTKShapeFeaturePtr& secondFeature, LTKShapeFeaturePtr& outResult ) const ;

	/**
	* @brief Subtracts two PoinFloatShapeFeature instances.
	*
	* @param secondFeature : LTKShapeFeature* : Base class pointer holding pointer to PointFloatShapeFeature instance
	*
	* @return LTKShapeFeature* : Pointer to PointFloatShapeFeature instance holding the result of subtraction.
	*	
	*/
	int subtractFeature(const LTKShapeFeaturePtr& secondFeature, LTKShapeFeaturePtr& outResult ) const ;

	int scaleFeature(float alpha, LTKShapeFeaturePtr& outResult) const ;

    int getFeatureDimension();
    
};

#endif
//#ifndef __POINTFLOATSHAPEFEATURE_H